I’ve gotten in the habit of using org-mode to organize text notes I take at various times. org-mode files can be transformed to a number of formats, including HTML.
Text markup. More stars in header means lower-level items. Blank lines between paragraphs. Indentation doesn’t matter (except for lists).
bold italic verbatim code (probably should use verbatim instead of code, because “code” has some weighted
meanings in org-mode (e.g., you can run code straight out of an org-mode file)).
Subscript: H2O (so don’t paste in code_with_underscores w/out surrounding it with =’s). (Superscript: E = mc^2.)
one-line code sample (leading colon) ok, maybe two lines
Multi-line example like maybe a pasted email or something you don't want line-wrapping or other /character interpretation/ applied to
Bullet lists:
- one
- two
- sub-item (indentation matters here)
Definitions:
- terms
- Can be defined
Checklists:
- [ ] Items can be…
- [X] …checked off
- [-] And (dash means “partially completed”)
- [X] you can have sublists
- [ ] if you really want to
Link to Google (although just pasting in a URL works fine, too (see “more info”, below)).
(Link syntax is link text to be displayed to user. You can leave the link text out.)
- More info than you ever cared for: https://orgmode.org
- If you truly want to go down the rabbit hole: https://melpa.org/#/?q=org-mode
If you want to update the contents of org-mode files and you’re not an emacs user (i.e., you’re a normal person), you might be able to use pandoc (https://pandoc.org/) to render the text file to whatever format you like.
See *On processing org-mode files with Pandoc.
(You might also be able to do it by installing emacs and using it as a command-line processor, but I haven’t figured that out quite yet.)
Alternatively, you can just DELETE the generated HTML file (including in any repositories where it exists) and update this text file without attempting to regenerate the HTML. In the end, it’s just text.
There is a program, pandoc (https://pandoc.org/), which can be used to turn this org-mode file into whatever you
want.
If you do use Pandoc, try the following command line:
pandoc --from=org --to=html5 --standalone --table-of-contents --toc-depth=6 --variable=secnumdepth:6 --number-sections --include-in-header=pandoc-header-extra.html --output=<output-html-file> <this-file>