Note Tool

How to build a site like this#

Finally, I get her

Goal of the tool#

A note with git (tried GH Wiki)

Preparation#

Explore Static Site Generators#

checked but not used

Free Obsidian Publish#

Used:zoni/obsidian-export
This export tool will maintain the markdown front matter
checked but not used
Made a shellscript to convert obsidian #TODO publish to GitHub and add more details on the shellscript.

Logic#

Obsidian here acts as a backlink extension with a nice preview UI. What I really need is a markdown with backlink.
Obsidian offers hashtag function as well.
MkDocs is a SSG converting .md files to HTML with some JS+CSS. It has same functionality as Hexo.
Netlify is a hosting service.

MkDocs#

Homepage is a tutorial: MkDocs
Setup everything in one file: mkdocs.yaml (simple but not as flexible, enough for me)

Theme: MkDocs-material#

Home page
Icon's reference (third party)
[ ] Customized theming colors is in some small link in the docs directing to GitHub #TODO clarify this. Make deploy-obsidian really global.

Markdown Extensions#

Sub-list indentation problem (I use 2 spaces and export-obsidian also generates 2-spaces indentation). Fixed with radude/mdx_truly_sane_lists

Why I didn't use Hexo#

@2021-11-25

I feel Hexo heavy: the yaml style comment is necessary and will decide the title of the page. Maybe I had some weird rules but I couldn't set filename of .md with space. Then every file needs a compulsory yaml comment. I actually cannot explain.

@2021-11-26

I don't use Hexo because:

It has a date-based structure. I prefer to arrange my things based on topics.
Being a Chinese project is not a problem. The problem is the theme: Theme contributors are mostly Chinese and there's no real good design, and I don't want to use EJS to write a new project. A lot of theme preview was deprecated(invalid URL). See the wealth is actually important.

[ ] #TODO External Brain of Pablo LION // was the old name with HEXO, should use obsidian arrow now

Reflection on refactor#

@2022-02-13
Trying to find a better app.

Notion	Obsidian	Markdown
Better page style	Convert to MD	Popularity
easy publish	Easy backlink	SCM(git)
access control	-Create empty files	Currently using.
Column	-Can't see filepath	VSCE: user dictionary.
		VSCE: Font.
		VSCE: Md lint.
		Publish with customized Style

What I need
MUST: Use any editor (VSCode for me)
Convert to HTML. There're lots of markdown to static HTML generate.
Backlink is not that important: showing file path is not that bad

Sum word count (move to shell?)#

#TODO: move

find . -iname "*.md" | tr -s '\n' '\0' | xargs -0 wc -w