Source code for xtreamwayz.netlify.app

Development

# init
docker run --rm --volume $(pwd):/src xtreamwayz/hugo npm ci
docker run --rm --volume $(pwd):/src xtreamwayz/hugo hugo mod init site

# build
docker run --rm --volume $(pwd):/src xtreamwayz/hugo hugo --gc --minify --enableGitInfo --environment production

# server
docker-compose up -d

For local development of package documentation, add one of these to go.mod

replace github.com/xtreamwayz/<project> => ../<project>
replace github.com/xtreamwayz/<project> => /Users/username/projects/<project>

GitHub pages integration

Add this file to a repository to trigger new builds if a file changed in the docs path. The NETLIFY_DOCS_BUILD_HOOK secret must also be set.

# .github/workflows/build-docs.yml
name: build-docs

on:
  push:
    branches:
      - master
    paths:
      - 'docs/**'

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Trigger build webhook on Netlify
        run: curl -s -X POST "https://api.netlify.com/build_hooks/${TOKEN}"
        env:
          TOKEN: ${{ secrets.NETLIFY_DOCS_BUILD_HOOK }}

Documentation

All project documentation is located in the ./docs folder. If you would like to contribute to the documentation, please submit a pull request. You can read the docs online: https://xtreamwayz.netlify.app/

Contributing

BEFORE you start work on a feature or fix, please read & follow the contributing guidelines to help avoid any wasted or duplicate effort.

Copyright and license

Code released under the MIT License. Documentation distributed under CC BY 4.0.