diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index 3d62184..0000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1,2 +0,0 @@ -custom: ["https://www.paypal.me/janraasch/29,00"] -github: ["janraasch"] diff --git a/.github/stale.yml b/.github/stale.yml index dc90e5a..86c4885 100644 --- a/.github/stale.yml +++ b/.github/stale.yml @@ -1,17 +1,18 @@ # Number of days of inactivity before an issue becomes stale -daysUntilStale: 60 +daysUntilStale: 90 # Number of days of inactivity before a stale issue is closed -daysUntilClose: 7 +daysUntilClose: 30 # Issues with these labels will never be considered stale exemptLabels: - pinned - security + - bug + - priority-high +exemptProjects: true +exemptMilestones: true # Label to use when marking an issue as stale -staleLabel: wontfix +staleLabel: no-activity # Comment to post when marking an issue as stale. Set to `false` to disable -markComment: > - This issue has been automatically marked as stale because it has not had - recent activity. It will be closed if no further activity occurs. Thank you - for your contributions. +markComment: false # Comment to post when closing a stale issue. Set to `false` to disable -closeComment: false +closeComment: false \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 569bd32..519e59f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -26,7 +26,7 @@ jobs: - name: Deploy to GitHub Pages if: github.event_name == 'push' - uses: peaceiris/actions-gh-pages@v3.8.0 + uses: peaceiris/actions-gh-pages@v3.9.2 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public diff --git a/.gitignore b/.gitignore index ea47378..643ea68 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ public exampleSite/public node_modules +*.lock diff --git a/README.md b/README.md index f2ca754..f28bc97 100644 --- a/README.md +++ b/README.md @@ -1,82 +1,56 @@ -# Hugo Scroll ![Test](https://github.com/janraasch/hugo-scroll/workflows/CI/badge.svg?branch=master&event=push) [![Pay me][paypal-svg]][paypal-dot-me] [![Sponsor me][github-sponsors-svg]][github-sponsors] +# Hugo Scroll +A [Hugo](https://gohugo.io/) theme for pretty, quick and simple single-page websites. -📜 A [Hugo](https://gohugo.io/)-theme for pretty, quick and simple single-page websites. +For live demo of master branch, please visit https://janraasch.github.io/hugo-scroll/. +![Test](https://github.com/janraasch/hugo-scroll/workflows/CI/badge.svg?branch=master&event=push) -![Screenshot Hugo Scroll Theme](https://raw.githubusercontent.com/janraasch/hugo-scroll/master/images/tn.png) - -## Demo - -For a current & working demo of this theme please check out https://janraasch.github.io/hugo-scroll/ 🎯. - -## Sponsor 💟 - -Support my work on this theme via [GitHub Sponsors][github-sponsors] (recurring) or [PayPal][paypal-dot-me] (one-time). - -[![GitHub Stats](https://github-readme-stats.vercel.app/api/?username=janraasch)][github-sponsors] +As a fallback, see a screenshot which may be a bit outdated: ![Screenshot Hugo Scroll Theme](https://raw.githubusercontent.com/janraasch/hugo-scroll/master/images/tn.png) ## Installation - If you already have a hugo site on your machine, you can simply add this theme via - ``` git submodule add https://github.com/janraasch/hugo-scroll.git themes/hugo-scroll ``` - -Then, adjust the `config.toml` as detailed below. +Then, adjust the `config.toml` as detailed below & in the file comments. If you simply want to check out the `exampleSite`, you can run - ``` git clone https://github.com/janraasch/hugo-scroll.git hugo-scroll cd hugo-scroll hugo server --source=exampleSite --themesDir=../.. ``` -For more information read the official [setup guide][hugo-setup-guide] of Hugo. - -## Adjust configuration / config.toml - -Please check out the [config.toml](https://github.com/janraasch/hugo-scroll/blob/master/exampleSite/config.toml) included on the [exampleSite](https://github.com/janraasch/hugo-scroll/tree/master/exampleSite) of this theme. - -## Content & structure - -### Starting fresh +For more information, read the official [Hugo setup guide][hugo-setup-guide]. If you are starting fresh, simply copy over the contents of the `exampleSite`-directory included in this theme to your source directory. That should give you a good idea about how things work, and then you can go on from there to make the site your own. -### Adding content +Please check out the [config.toml](https://github.com/janraasch/hugo-scroll/blob/master/exampleSite/config.toml) included on the [exampleSite](https://github.com/janraasch/hugo-scroll/tree/master/exampleSite) of this theme. -You can add **a new section to the homepage** via running +You can add **a new section to the homepage** by running `hugo new homepage/my-new-content.md` (or craft the file manually) -``` -hugo new homepage/my-new-content.md -``` - -To create **a page separate from the homepage**, run - -``` -hugo new my-new-page.md -``` - -### Using icons - -This theme includes the full set of [Fork Awesome 1.1.7 Icons][fork-awesome-icons]. Use the `{{}}`-[shortcode][hugo-shortcodes] with the respective "fa fa-ICONNAME"-`class` to use an icon directly in your `.markdown` files à la +To create **a page separate from the homepage**, run `hugo new my-new-page.md` +## Features +### Icons +This theme includes the full set of [Fork Awesome 1.2.0 Icons][fork-awesome-icons]. Use the `{{}}`-[shortcode][hugo-shortcodes] with the respective "fa fa-ICONNAME"-`class` to use an icon directly in your `.markdown` files à la ```markdown -Look at this nice »envelope«-icon: {{}}. I took this from https://forkaweso.me/Fork-Awesome/icon/envelope/ :-) +Look at this nice »envelope«-icon: `{{}}`. I took this from https://forkaweso.me/Fork-Awesome/icon/envelope/ :-) ``` -For the full list of icons, see [Fork Awesome 1.1.7 Icons][fork-awesome-icons]. +### External links +You can add external link in the menu, see `external.md` in the `exampleSite`. -### Adding your branding / colors / css +You can also use `extlink` shortcode to create a link opening in new tab: +```markdown +Visit as at {{}} +``` +### Customizing CSS Add a `custom_head.html`-file to your `layouts/partials`-directory. In there you may add a `