From fa13a72e606540ab7e0ff925935e08a4d74bf55e Mon Sep 17 00:00:00 2001 From: StefMa Date: Tue, 16 Feb 2021 09:24:52 +0100 Subject: [PATCH] Add docs --- .github/workflows/docs-to-gh-pages.yml | 29 +++ docs/config.yml | 21 ++ docs/content/getstarted.md | 80 +++++++ docs/content/landingpage.md | 307 +++++++++++++++++++++++++ docs/content/singlepage.md | 27 +++ docs/content/troupleshooting.md | 10 + docs/go.mod | 5 + docs/go.sum | 2 + 8 files changed, 481 insertions(+) create mode 100644 .github/workflows/docs-to-gh-pages.yml create mode 100644 docs/config.yml create mode 100644 docs/content/getstarted.md create mode 100644 docs/content/landingpage.md create mode 100644 docs/content/singlepage.md create mode 100644 docs/content/troupleshooting.md create mode 100644 docs/go.mod create mode 100644 docs/go.sum diff --git a/.github/workflows/docs-to-gh-pages.yml b/.github/workflows/docs-to-gh-pages.yml new file mode 100644 index 0000000..7c572e0 --- /dev/null +++ b/.github/workflows/docs-to-gh-pages.yml @@ -0,0 +1,29 @@ +name: Deploy docs + +on: + push: + branches: + - master + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - name: Setup Hugo + uses: peaceiris/actions-hugo@v2 + with: + hugo-version: '0.58.3' + extended: true + + - name: Build + run: hugo --minify + working-directory: docs + + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + force_orphan: true + publish_dir: docs/public diff --git a/docs/config.yml b/docs/config.yml new file mode 100644 index 0000000..02c1a6a --- /dev/null +++ b/docs/config.yml @@ -0,0 +1,21 @@ +baseURL: "https://stefma.github.io/hugo-fresh" +languageCode: "en-us" +title: "Hugo Fresh documentation" +module: + imports: + path: github.com/StefMa/hugo-fresh + +params: + navbarlogo: + image: logos/fresh.svg + link: /hugo-fresh + hero: + title: hugo fresh documentation + subtitle: Probably the best hugo theme out there! + buttontext: Go to docs + buttonlink: getstarted + image: illustrations/worker.svg + navbar: + - title: GitHub + url: https://github.com/StefMa/hugo-fresh + button: true diff --git a/docs/content/getstarted.md b/docs/content/getstarted.md new file mode 100644 index 0000000..bddfd68 --- /dev/null +++ b/docs/content/getstarted.md @@ -0,0 +1,80 @@ +--- +title: Get Started +sidebar: true +sidebarlogo: fresh-white +include_footer: false +--- + +## The Fresh theme for Hugo + +**Fresh** is a theme for the [Hugo](https://gohugo.io) static site generator adapted from the gorgeous, [Bulma](https://bulma.io)-based theme of the same name from [CSS Ninja](https://cssninja.io/themes/fresh). You can find a live demo of the original theme [here](https://cssninjastudio.github.io) and a live demo of the Hugo theme [here](https://hugo-fresh.now.sh/). + + + +## Getting started + +To create a new site using this theme + +
+with git submodules + +```bash +# Create site and cd into it +hugo new site my-site && cd my-site + +# Clone the Fresh theme +git clone https://github.com/StefMa/hugo-fresh themes/hugo-fresh + +# Remove the default config +rm config.toml + +# Fetch the example config +curl -O https://raw.githubusercontent.com/StefMa/hugo-fresh/master/exampleSite/config.yaml + +# Run the site locally +hugo server + +# Open the site in your browser +open http://localhost:1313 +``` + +
+ +
+with hugo modules + +```bash +# Create site and cd into it +hugo new site my-site && cd my-site + +# Transform your hugo site to an module +hugo mod init YOUR_MODULE_NAME + +# Remove the default config +rm config.toml + +# Fetch the example config +curl -O https://raw.githubusercontent.com/StefMa/hugo-fresh/master/exampleSite/config.yaml + +# Replace theme with module in config.yaml +#theme: [hugo-fresh] +module: + imports: + path: github.com/StefMa/hugo-fresh + +# Run the site locally +hugo server + +# Open the site in your browser +open http://localhost:1313 +``` + +
+ +## Customizing your page + +Checkout the [Landing page docs](../landingpage) to customize the landing page. + +There is also the option to create single pages. Check the [Single page docs](../singlepage) for more. + +Have some troubles? Check our [troubleshooting](../troubleshooting) guide. diff --git a/docs/content/landingpage.md b/docs/content/landingpage.md new file mode 100644 index 0000000..4c2add9 --- /dev/null +++ b/docs/content/landingpage.md @@ -0,0 +1,307 @@ +--- +title: Landing page +sidebar: true +sidebarlogo: fresh-white +include_footer: false +--- + +## Customize the landing page +There's a wide variety of customizations that you can make to your Hugo Fresh landing page by modifying the `config.yaml` file that you downloaded. + +### navbarlogo +Define the logo of the navigationbar in the upper left corner. + +
+Code + +```yaml +navbarlogo: + image: logos/fresh.svg # Logo (from static/images/logos/) + link: / +``` + +
+ +### font +Set the font of the site. + +
+Code + +```yaml +font: + name: "Open Sans" + sizes: [400,600] +``` + +
+ +### hero +The "main" page which you see when you open the website. + +
+Code + +```yaml +hero: + title: Manage. Deploy. + subtitle: Lorem ipsum sit dolor amet is dummy text used by the typography industry + buttontext: Get started + buttonlink: "#" + image: illustrations/worker.svg + # Footer logos (from static/images/logos/clients/*.svg) + clientlogos: + - systek + - tribe + - kromo + - infinite + - gutwork +``` + +
+ +### navbar +The navigation bar which is at the top of the site. +For a dropdown, add a "sublinks" list. + +
+Code + +```yaml +navbar: +- title: Features + url: / +- title: Pricing + url: / +- title: Dropdown + sublinks: + - title: Dropdown item + url: / + - title: Dropdown item + url: / + - title: Dropdown item + url: / +- title: Log in + url: / +- title: Sign up + url: / + button: true +``` + +
+ +### sidebar +The sidebar is an optional parameter where you can place even more navigation items. + +
+Code + +```yaml +sidebar: + # Logo (from /images/logos/___.svg) + logo: fresh-square + sections: + - title: User + icon: user + links: + - text: Profile + url: / + - text: Account + url: / + - text: Settings + url: / + - title: Messages + icon: envelope + links: + - text: Inbox + url: / + - text: Compose + url: / + - title: Images + icon: image + links: + - text: Library + url: / + - text: Upload + url: / + - title: Settings + icon: cog + links: + - text: User settings + url: / + - text: App settings + url: / +``` + +
+ +### section1 +Describes the second "page" which you will see when you scroll down. Currently it will have **always** three `titles`. + +
+Code + +```yaml +section1: + title: Great power comes + subtitle: with great responsibility + tiles: + - title: App builder + icon: mouse-globe + text: This is some explanatory text that is on two rows + url: / + buttonText: Free trial + - title: Cloud integration + icon: laptop-cloud + text: This is some explanatory text that is on two rows + url: / + buttonText: Get started + - title: Add-ons & plugins + icon: plug-cloud + text: This is some explanatory text that is on two rows + url: / + buttonText: Get started +``` + +
+ +### section2 +Shows information why someone should use this product. + +
+Code + +```yaml +section2: + title: You're here because you want the best + subtitle: And we know it + features: + - title: Powerful and unified interface + text: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin ornare magna eros, eu pellentesque tortor vestibulum ut. Maecenas non massa sem. Etiam finibus odio quis feugiat facilisis. + # Icon (from /images/illustrations/icons/___.svg) + icon: laptop-globe + - title: Cross-device synchronisation + text: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin ornare magna eros, eu pellentesque tortor vestibulum ut. Maecenas non massa sem. Etiam finibus odio quis feugiat facilisis. + icon: doc-sync + - title: Nomad system + text: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin ornare magna eros, eu pellentesque tortor vestibulum ut. Maecenas non massa sem. Etiam finibus odio quis feugiat facilisis. + icon: mobile-feed +``` + +
+ +### section3 +Display a bright image of your product. + +
+Code + +```yaml +section3: + title: One platform + subtitle: To rule them all + image: illustrations/mockups/app-mockup.png + buttonText: Get started + buttonLink: "#" +``` + +
+ +### section4 +What clients says about us. + +
+Code + +```yaml +section4: + title: Our Clients love us! + subtitle: Lorem ipsum sit dolor amet is a dummy text used by typography industry + clients: + - name: Irma Walters + quote: Lorem ipsum dolor sit amet, elit deleniti dissentias quo eu, hinc minim appetere te usu, ea case duis scribentur has. Duo te consequat elaboraret, has quando suavitate at. + job: Accountant + img: 1 # From (static/images/illustrations/faces) + - name: John Bradley + quote: Lorem ipsum dolor sit amet, elit deleniti dissentias quo eu, hinc minim appetere te usu, ea case duis scribentur has. Duo te consequat elaboraret, has quando suavitate at. + job: Financial Analyst + img: 2 + - name: Gary Blackman + quote: Lorem ipsum dolor sit amet, elit deleniti dissentias quo eu, hinc minim appetere te usu, ea case duis scribentur has. Duo te consequat elaboraret, has quando suavitate at. + job: HR Manager + img: 3 +``` + +
+ +### section5 +Write us. + +
+Code + +```yaml +section5: true # or false to hide it +``` + +
+ +### footer +The footer of the site. + +
+Code + +```yaml +footer: + # Logo (from /staticimages/logos/___) + logo: fresh-white-alt.svg + # Social media links (GitHub, Twitter, etc.). All are optional. + socialmedia: + - link: https://github.com/StefMa/hugo-fresh + # Icons are from Font Awesome + icon: github + - link: https://dribbble.com/# + icon: dribbble + - link: https://facebook.com/# + icon: facebook + - link: https://twitter.com/lucperkins + icon: twitter + - link: https://bitbucket.org/# + icon: bitbucket + bulmalogo: true + quicklinks: + column1: + title: "Product" + links: + - text: Discover features + link: / + - text: Why choose our product? + link: / + - text: Compare features + link: / + - text: Our roadmap + link: / + - text: AGB + link: /agb + column2: + title: "Docs" + links: + - text: Get started + link: / + - text: User guides + link: / + - text: Admin guide + link: / + - text: Developers + link: / + column3: + title: "Blog" + links: + - text: Latest news + link: /blog/first + - text: Tech articles + link: /blog/second +``` + +
diff --git a/docs/content/singlepage.md b/docs/content/singlepage.md new file mode 100644 index 0000000..55343f2 --- /dev/null +++ b/docs/content/singlepage.md @@ -0,0 +1,27 @@ +--- +title: Single page +sidebar: true +sidebarlogo: fresh-white +include_footer: false +--- + +## Creating a single page +Single pages displays a single unit of information and are more or less independent from the landing page above. + +You can create single pages in the `content` directory (even sub-dirs are possible). + +If you'd like to have the footer displayed on your single page include `include_footer: true` in your front matter. + +
+Code + +```yaml +--- +title: AGB +sidebar: true # or false to display the sidebar +sidebarlogo: fresh-white-alt # From (static/images/logo/) +include_footer: true # or false to display the footer +--- +``` + +
diff --git a/docs/content/troupleshooting.md b/docs/content/troupleshooting.md new file mode 100644 index 0000000..7312a5d --- /dev/null +++ b/docs/content/troupleshooting.md @@ -0,0 +1,10 @@ +--- +title: Troubleshooting +sidebar: true +sidebarlogo: fresh-white +include_footer: false +--- + +## Hugo extended + +If you see `error: failed to transform resource: TOCSS: failed to transform "style.sass"` when attempting to run your `hugo server`, make sure you have the extended version of Hugo installed! diff --git a/docs/go.mod b/docs/go.mod new file mode 100644 index 0000000..db9dd1f --- /dev/null +++ b/docs/go.mod @@ -0,0 +1,5 @@ +module github.com/stefma/hugo-fresh/docs + +go 1.15 + +require github.com/StefMa/hugo-fresh v0.0.0-20210215141724-0fa1741f382c // indirect diff --git a/docs/go.sum b/docs/go.sum new file mode 100644 index 0000000..133f2e2 --- /dev/null +++ b/docs/go.sum @@ -0,0 +1,2 @@ +github.com/StefMa/hugo-fresh v0.0.0-20210215141724-0fa1741f382c h1:QYmEuOnjZddrD7PAaMfOF5QcK6DuuQRANhb7CWY2h4o= +github.com/StefMa/hugo-fresh v0.0.0-20210215141724-0fa1741f382c/go.mod h1:0kyrjS5vdFJ47D7bPs6JwXTkctiMaQbToeBaOQsw1Tw=