Skip to content

GitHub - Jackiexiao/foam-mkdocs-template: using mkdocs / mkdocs-material / mkdocs-roamlinks-plugin#

Foam/Obsidian-mkdocs-template#

中文文档

foam-mkdocs-template-png

  • Share your foam/obsidian/markdown notes in a simple and intuitive way ! Support [[roamlike link]]

This template use mkdocs, mkdocs-material, mkdocs-roamlinks-plugin and many mkdocs plugins.

Demo#

Usage：Deploy to github page#

  1. fork this repository , go to repo setting -> action -> workflow permissions change to read and write permissions
  2. copy .github mkdocs.yml requirements.txt to your repo, and create docs directory
  3. add your documents to docs , docs/index.md is the main page of the website

  4. open mkdocs.yml, modify site_name to your website name, this file is the setting of website, visit link below to get more information(for example, you may want to change language to en)

  5. mkdocs-material

  6. mkdocs

  7. push to github, ps: before push to github, you may want to preview your website locally, please view deploy locally

  8. go to github setting, open github page, choose gh-pages branch, wait a moment, then visit http://<your-github-username.github.io/<your-repo>, for example:jackiexiao.github.io/blog/
  9. Done! That's all! Have fun!

Thx to Github Action, it make deploy a blog so easy, all you need todo is modify and push your file

Deploy Locally#

The simplest way: Enter your local repo directory, make sure your python > 3.6

pip install -U -r requirements.txt
mkdocs serve

Then visit http://127.0.0.1:8000/

Support syntax#

This template will convert roam/obsidian/foam like links to web support links

origin

convert

[Git Flow](git_flow.md)

[Git Flow](../software/git_flow.md)

[[Git Flow]]

[Git Flow](../software/git_flow.md)

![[image.png]]

![image.png](../image/imag.png)

[#Heading identifiers](<#heading-identifiers>)

[Heading identifiers in HTML](#heading-identifiers-in-html)

[[Git Flow#Heading]]

[Git Flow](../software/git_flow.md#heading)