https://github.com/vzhong/mkdocs-pugjs-website-boilerplate

https://github.com/vzhong/mkdocs-pugjs-website-boilerplate

Last synced: 30 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/vzhong/mkdocs-pugjs-website-boilerplate
• Owner: vzhong
• Created: 2023-09-15T17:46:29.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-16T01:37:57.000Z (about 1 year ago)
• Last Synced: 2024-04-23T00:12:35.556Z (7 months ago)
• Language: Pug
• Size: 5.86 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Template Website

This is the source code for a website.

At a high level, the website works as follows:

- `mkdocs` is used to generate a static website from the markdown files in `docs` and the CSS theme in `victor_theme`.

- the generated website is located in `site`

- `deploy.sh` pushes the content in `site` to a branch called `gh-pages`

## To develop

First, install dependencies and start a development server:

```

pip install -r requirements.txt

mkdocs serve

```

If you need to only modify data: change the corresponding entries in `data/*.yaml`.

If you need to modify non-data content: edit the files in `docs` to your liking.

As you make changes, the local development server should reflect those changes in real time.

Finally, deploy your changes via `bash deploy.sh`.

This command will build the static website in `site` and then push it to the correct branch.

### On modifying the template

You should rare need to modify `victor_theme`.

But in the event that you do need to modify the HTML files,

the HTML variant we use is [PugJS](https://pugjs.org/) - it makes our source files a lot smaller.

The PugJS source files `*.pug` is compiled into HTML.

Therefore, when modifying, do **not** modify HTML files directly.

Instead, modify the `*.pug` files and your changes will be compiled into HTML.