https://github.com/aasmpro/gruvdoc
Pre-configured MkDocs project with GruvBox colors and JetBrainsMono font.
https://github.com/aasmpro/gruvdoc
gruvbox hacktoberfest mkdocs python theme
Last synced: 3 months ago
JSON representation
Pre-configured MkDocs project with GruvBox colors and JetBrainsMono font.
- Host: GitHub
- URL: https://github.com/aasmpro/gruvdoc
- Owner: aasmpro
- License: mit
- Created: 2021-08-31T20:36:05.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-10-17T07:05:12.000Z (about 3 years ago)
- Last Synced: 2025-04-07T04:41:17.353Z (7 months ago)
- Topics: gruvbox, hacktoberfest, mkdocs, python, theme
- Homepage: https://abolfazlamiri.ir/gruvdoc/
- Size: 2.38 MB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## [GruvDoc](https://abolfazlamiri.ir/gruvdoc/)
GruvDoc is pre-configured [MkDocs](https://www.mkdocs.org/) project with all the must useful extensions and tweaks needed, just Fork, Change and Push!
check [Demo](https://abolfazlamiri.ir/gruvdoc/demo/abbreviations/) or [Docs](https://abolfazlamiri.ir/gruvdoc/docs/colors/) for more information.
### Features
- GruvDoc is all extra config files, anything can be [changed](https://abolfazlamiri.ir/gruvdoc/#you-dont-want-tweaks) easily.
- Tweaks [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) under the hood!
- [GruvBox](https://abolfazlamiri.ir/gruvdoc/docs/colors/) color palette with 24 different colors for both primary and accent.
- [JetBrainsMono](https://abolfazlamiri.ir/gruvdoc/docs/fonts/) font.
- Simple, pre-configured [mkdocs.yml](https://github.com/aasmpro/gruvdoc/blob/master/mkdocs.yml) file.
- [Github](https://github.com/aasmpro/gruvdoc/blob/master/.github/workflows/gruvdoc.yml) / [Gitlab](https://github.com/aasmpro/gruvdoc/blob/master/.gitlab-ci.yml) Workflows included for auto Deployment!
- Including [Styles](https://abolfazlamiri.ir/gruvdoc/docs/styles/) and custom [Utils](https://abolfazlamiri.ir/gruvdoc/docs/utils/).
### Usage
[Fork](https://github.com/aasmpro/gruvdoc/fork) GruvDoc github repo and Clone it or Clone the main repo:
```
git clone https://github.com/aasmpro/gruvdoc.git
```
> by [Forking](https://github.com/aasmpro/gruvdoc/fork) you don't need to create and set new repo.
create a virtual environment and install packages:
```
pip install -r requirements/gruvdoc.txt
```
serve your local version and start editing!
```
mkdocs serve
```
when you are done, commit and push changes. workflows will take care of deployments.
check [mkdocs-material/publishing](https://squidfunk.github.io/mkdocs-material/publishing-your-site/) for more information.
#### In another repo
if you want to add GruvDoc in another project:
- copy `docs` folder to your project
- copy `mkdocs.yml` file to your project
- copy `requirements` folder to your project
- copy `.github/workflows/gruvdoc.yml` or `.gitlab-ci.yml` for workflows
### You don't want tweaks?!
you rather using GrubDoc without its tweaked theme? no problem!
just comment extra css section in `mkdocs.yml` file:
```yaml
## Extra css files
### comment these lines,
### if you want to use default material theme
extra_css:
- assets/stylesheets/fonts.css
- assets/stylesheets/vars.css
- assets/stylesheets/scheme.css
- assets/stylesheets/primary.css
- assets/stylesheets/accent.css
- assets/stylesheets/admonitions.css
- assets/stylesheets/utils.css
- assets/stylesheets/styles.css
```
and then set your palette:
```yaml
## Theme settings
theme:
name: material
### comment these lines,
### if you want to use default material theme
palette:
scheme: gruvbox
primary: green
accent: green
### uncomment to use default material theme
# palette:
# scheme: default
```
you can change anything by editing only `mkdocs.yml` file.