https://github.com/newtonproject/newdocs-hugo
NewDocs Theme for Hugo
https://github.com/newtonproject/newdocs-hugo
Last synced: 3 months ago
JSON representation
NewDocs Theme for Hugo
- Host: GitHub
- URL: https://github.com/newtonproject/newdocs-hugo
- Owner: newtonproject
- License: apache-2.0
- Created: 2020-12-22T04:24:36.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-01-22T07:26:45.000Z (over 4 years ago)
- Last Synced: 2025-01-22T08:16:28.798Z (5 months ago)
- Language: CSS
- Size: 3.77 MB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NewDocs Hugo Theme
NewDocs makes it easy to create & edit a Project or Documentation website with Hugo, and deploy with GitHub or Netlify.
## Currently in Pre-release Beta
The first stable release will be `v0.60.0`.
Before that use carefully since:
- Things may break between different versions
- Demo site may change between different versions
- Documentation may not be fully covered
To learn more about **Plans & Roadmap** to this project, see [Issue #29: What is NewDocs Hugo theme?](https://github.com/newtonproject/newdocs-hugo/issues/29). Discussions are welcome under that issue.
## Get Started
### Requirement
**Option 1: Using Hugo Natively**
See [Install Hugo](https://gohugo.io/getting-started/quick-start/#step-1-install-hugo) Section from Hugo Official Docs.
**Option 2: Using Hugo with NPM or Yarn**
NPM: `npm install hugo-bin hugo-bin-extended --save-dev`
Yarn: `yarn add hugo-bin hugo-bin-extended --dev`
### Install Theme
There are many ways to use this Theme, choose which one fits your project:
**Option 1: The Traditional Hugo Way**
```
git submodule add https://github.com/newtonproject/newdocs-hugo.git themes/newdocs
```
**Option 2: Use from This Repo**
`TBD`
## License
[Apache-2.0 License](LICENSE)
## Thanks To
Other open-source projects used in this Theme:
- [Hugo](https://gohugo.io/)
- [FlexSearch.js](https://github.com/nextapps-de/flexsearch) by Nextapps GmbH
- [KaTeX](https://katex.org)
- [mermaid](https://github.com/mermaid-js/mermaid)
- [Normalize.css](https://github.com/necolas/normalize.css/) by Nicolas Gallagher
- [Poppins Fonts](https://github.com/itfoundry/poppins) by Indian Type Foundry
- [Nerd Fonts](https://github.com/ryanoasis/nerd-fonts)
- [Bootstrap Icons](https://icons.getbootstrap.com)