search

jobindjohn / obsidian-publish-mkdocs

A Template to Publish Obsidian/Foam Notes on Github Pages (uses MkDocs)
Creative Commons Zero v1.0 Universal
500 stars 38 forks source link

Instructions to build locally using mkdocs #1

Open jobindjohn opened 3 years ago

jobindjohn commented 3 years ago
Ravieroy commented 2 years ago

Hello Dev, While using your template I made my GitHub page and I could serve it locally as well. So i thought since this issue is present here, I might put how I did it. I have tested it on my machine and it works. requirements.txt file is attached here with a screenshot of the local build. If it added in the main repo, great else others might try it for themselves. 

pip install -r requirements.txt

P.S: Make sure that the directory of installation(usually $HOME/.local/bin) is in the path(usually this is an issue for a fresh install)

requirements.txt

img

Contents of requirements.txt

mkdocs mkdocs-material mkdocs-mermaid2-plugin mkdocs-ezlinked-plugin mkdocs-awesome-pages-plugin mdx_breakless_lists mkdocs-preview-links-plugin mkdocs-embed-file-plugins Markdown obs2mk mkdocs-roamlinks-plugin PyYAML==6.0 setuptools==60.8.2

Tindalos commented 1 year ago

This was very useful. Can confirm it works in Win.

jobindjohn commented 1 year ago

Thanks @Ravieroy and @Tindalos . I'll include this as part of the setup instructions.

LukasStordeur commented 1 month ago

Update: if you are using python 3.12, you'll need to use PyYAML==6.0.1 instead. And if you want to serve the docs locally, you also might need the mkdocs-rss-plugin.