/tech-notes

My technical & Computer Science Notes

Primary LanguagePython

Personal Technical Notes & Documentation

Self-maintained technical notes & documentation, forming my technical PKM. PR's are welcome!

To keep the maintenance burden to a minimum, the content is only cataloged using directories. No other indexes are provided.

However, using a documentation platform such as Read the Docs, you are able to auto-generated a hierarchical view of this content.

-- Marco Vedovati (docs (at) sba dot lat)

Read the Docs

I am using Read the Docs + mkdocs to auto-generate HTML from Markdown. For local development & testing, this command will bring up a local webserver rendering documentation pages:

$ mkdocs serve [-a LISTEN-IP:LISTEN-PORT] [--livereload]

Linting

Use ruby-mdl.