bckd00r / twitch4j.github.io

Twitch4J Page

Twitch4J Page

Page content builded via Hugo and custom-maded layout. With Bootstrap assets (delivered from package.json).

Contest

• Documentation - with breadcrumb navigation and sidebar lvl 2 menu
• Javadoc (generated from JDK9+ - Recommended JDK11 which are current LTS)
• Search (using fuse.js

Configuration

Using config.yml we define a custom menu content... and the other stuff.

Write your documentation

Ckecout how to utilize this custom template.

Additional Notes

To before starting editing documentation you needs

• hugo - to generate this page
• node - to install and deliver those packages

IMPORTANT: This readme is not a part of the content generated by hugo.

Live View

To editing this project type in project console npm start or hugo server

Generate files

To generate ready to deploy project just type in project console npm run generate or npm run generate:minify. All content are be generated in: public folder.

GitHub Actions

Project will automatically generate files and push them into gh-pages branch. To define own configuration please go to .github/workflows/gh-pages.yml and follow those useful documentation:

• Github Actions Documentation
• GitHub Actions for GitHub Pages
• GitHub Actions for Hugo

License

This project is under MIT License