The purpose of the note format, is to provide a stream-of-consciousness for thought, and to be parseable to html, and to be readable in text format (indeed, assume that the primary method is text format, especially for note-taking in terminal)

Header

SubHeader

Section Headers: ! - A realization ? - A question that we will be investigating Four spaces " text" is a big header line Two spaces " text" is a normal header space headers must be either start of file or have two newlines before List Types One indent for separation, to indicate a list - A dash for an unordered list i) for ordered lists of vague ideas ii) use roman numerals iii) because it forces shorter lists (a) for ordered lists of specific steps/instructions (b) cont... ↳ is a little arrow, often indicating a corrolary point to an above sentence bold text is with multiplication stars

*bold*

bold italic text is with tildes

~bold~

italicized text underlined text is with underscores

_bold_

underlined text strikethrough text is with hyphens on both sides,

--strike--

~~strike~~

_thing_

in markdown being bold is one of the key reasons I made this format 8 dashes is an explicit end of a section (imagine a page ending with a blank after the text)

$!\int_{0}^{\inf}$! is interpreted as inline latex (will probably change to more restrictive rules) $$!\int_{0}^{\inf}$$! is interpreted as a latex section a section ending with a colon: and then with lines like this is treated like a list where formatting of its columns matter, but a monospace font should render it as intended

this is unformatted text

inline formatted:

inline unformatted

a language can be specified for a parser in backticks with an exclamation mark, e.g. "```!cpp #include class bboy {int x;}; ```"

#include <iostream>
class bboy {int x;};

and inline "`!cpp #include `"

#include <iostream>

on an invalid language, the ?lang token is passed through to the final output If rendered as an output format, raw URIs like www.google.com or gopher://gopher.space become syntax highlighted, and paths to image files in directories relative to serving root become links to images or embedded images, depending on the format TODO lists [ ] for an open item [x] for a completed item [-] for an eliminated item Debug-Note-Specific Indicators: - sentences/lines ending in (?) indicate a hypothesis - non-checkbox [text] brackets indicate a reference to a previous topic/idea date is specified with the pound sign, and indicates the start of a debug session or logging, to provide context the format follows

date -R

# Wed, 06 Oct 2021 21:53:03 -0400 this denotes the start or resumption of a series of notes, usually only cause by a long series of debugging battles definitions, axioms, semantic assignments are provided by

:=

operation, may not need a special ascii/unicode character apple := good Perfect example of notes here: https://gitlab.com/nyarmith/technical_book_notes/-/blob/master/http_the_definitive_guide/notes Images are handled with:

[img src="url" OR file="local-fs"](alternative-text)

that's it for now Format TODO: [ ] figure out how embedded links should work (both within the document and external) [ ] figure out if I want to deal with centering images and such [ ] decide on whether I want a table of contents shorthand, and what the equivalent in vim would be