Installing Python/mkdocs
pip install mkdocs-material "mkdocs-material[imaging]" mkdocs-minify-plugin mdx-breakless-lists mkdocs-git-revision-date-localized-plugin mkdocs-roamlinks-plugin mkdocs-callouts pygments python-frontmatter
mkdocs-git-revision-date-localized-plugin
, setfallback_to_build_date
totrue
.
mkdocs writing requirements and it’s gotchas can be found here mkdocs
Exporting bookstack to mkdocs, there are helper scripts found in infra repo and bookstack2obsidian
mkdocs Giscus
- first install the giscus app
- then create a public repo
- enable discussion in that repo
- go to
Settings -> General -> Features
, turn onDiscussion
- go to
- on the Giscus app, enter the repo name
- copy the generated snippet
On mkdocs, create a new filecomments.html
./overrides/partial
add this intomkdocs.yml
theme:
name: 'material'
custom_dir: 'overrides'
Copy and paste these lines into comments.html
, replace the lines with snippets
if nessecary
Lastly, add the frontmatter comments: true
to the md page
Github Pages
To simply deploy, just run mkdocs gh-deploy
, it will build the site and automatically deploy to github.
To deploy the site to multiple places, consult obsidian-shell.
This is the best CSS settings for editing in obsidian, CSS can be edited following these steps in .obsidian/snippets
folder
body {
--h1-size: 1.5em;
--h2-size: 1.4em;
--h3-size: 1.2em;
--h4-size: 1.12em;
--h5-size: 1.05em;
--h6-size: 1.05em;
}