I’ve decided on a strict subset of commonmark to implement for this:
Italics: *Italics*
Bold: __Bold__
Heading: # Heading 1 (will be used for section number), ## Heading 2 (for all other headings)
Link: [Text][Ref] and at the bottom of the doc [Ref] http://example.com
List: - List item
Numbered List: 1. Numbered item
Code: three backticks to open/close blocks and one backtick to open and close inline code
Quote Block: > Quote Block
plus a couple of extensions:
Underline: _Underline_
Strikethrough: ~Strikethrough~
Comments: ; Comment
I’ve decided on a strict subset of commonmark to implement for this:
- Italics: `*Italics*`
- Bold: `__Bold__`
- Heading: `# Heading 1` (will be used for section number),` ## Heading 2` (for all other headings)
- Link: `[Text][Ref]` and at the bottom of the doc `[Ref] http://example.com`
- List: `- List item`
- Numbered List: `1. Numbered item`
- Code: three backticks to open/close blocks and one backtick to open and close inline code
- Quote Block: `> Quote Block`
plus a couple of extensions:
Underline: `_Underline_`
Strikethrough: `~Strikethrough~`
Comments: `; Comment`
Could # headers be specifically for title/section metadata?
For example, roff:
.TH PAGE 1
and my proposed equivalent usage in doc:
# PAGE(1)
Or PAGE 1 or whatever would be best. Just an idea. It would also be nice to have ### - just in general it may be handy but also in particular with # being title specification.
I think the following would be more consistent: **bold**, __underline__, ~~strikethrough~~, //italic//. All of these are flanked by two of the same rune on either side, which helps writers remember them easier.
And then potentially if they're useful (or even theoretically so) \\diminished\\ (e.g. <small /> in obsolete HTML, or like whispers in comic books) (edit: backslashes as markup is a bad idea), ^^superscript^^, ,,subscript,,, but I'm not in love with any of these, they're just ideas I thought up.
It would be nice to have in-line references, maybe similarly to MediaWiki. I don't wanna scroll down to find the hyperlink for a reference and then have to find my previous position.
; is a fine comment character. I'm a little wary of common punctuation but starting a line with a semicolon is unusual and nonsensical so it's probably fine. If it initiates a comment at any point in a line though and not at the start that could be a big problem.
Could `#` headers be specifically for title/section metadata?
For example, roff:
```
.TH PAGE 1
```
and my proposed equivalent usage in doc:
```
# PAGE(1)
```
Or `PAGE 1` or whatever would be best. Just an idea. It would also be nice to have `###` - just in general it may be handy but also in particular with `#` being title specification.
I think the following would be more consistent: `**bold**`, `__underline__`, `~~strikethrough~~`, `//italic//`. All of these are flanked by two of the same rune on either side, which helps writers remember them easier.
And then potentially if they're useful (or even theoretically so) ~~`\\diminished\\` (e.g. `<small />` in obsolete HTML, or like whispers in comic books)~~ (**edit: backslashes as markup is a bad idea**), `^^superscript^^`, `,,subscript,,`, but I'm not in love with any of these, they're just ideas I thought up.
It would be nice to have in-line references, maybe similarly to MediaWiki. I don't wanna scroll down to find the hyperlink for a reference and then have to find my previous position.
`;` is a fine comment character. I'm a little wary of common punctuation but starting a line with a semicolon is unusual and nonsensical so it's probably fine. If it initiates a comment at any point in a line though and not at the start that could be a big problem.
In my opinion, it would be a good idea to make this two programs, rtfm and a text formatter, where the former calls upon the latter. This would enable other programs to make use of this language.
In my opinion, it would be a good idea to make this two programs, rtfm and a text formatter, where the former calls upon the latter. This would enable other programs to make use of this language.
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
https://commonmark.org/
I’ve decided on a strict subset of commonmark to implement for this:
*Italics*__Bold__# Heading 1(will be used for section number),## Heading 2(for all other headings)[Text][Ref]and at the bottom of the doc[Ref] http://example.com- List item1. Numbered item> Quote Blockplus a couple of extensions:
Underline:
_Underline_Strikethrough:
~Strikethrough~Comments:
; CommentCould
#headers be specifically for title/section metadata?For example, roff:
and my proposed equivalent usage in doc:
Or
PAGE 1or whatever would be best. Just an idea. It would also be nice to have###- just in general it may be handy but also in particular with#being title specification.I think the following would be more consistent:
**bold**,__underline__,~~strikethrough~~,//italic//. All of these are flanked by two of the same rune on either side, which helps writers remember them easier.And then potentially if they're useful (or even theoretically so)
\\diminished\\(e.g.<small />in obsolete HTML, or like whispers in comic books)^^superscript^^,,,subscript,,, but I'm not in love with any of these, they're just ideas I thought up.It would be nice to have in-line references, maybe similarly to MediaWiki. I don't wanna scroll down to find the hyperlink for a reference and then have to find my previous position.
;is a fine comment character. I'm a little wary of common punctuation but starting a line with a semicolon is unusual and nonsensical so it's probably fine. If it initiates a comment at any point in a line though and not at the start that could be a big problem.I think comments should probably be
;;Another point against roff is that it can run arbitrary commands.
@trinity mentioned renaming this to the more interesting
rtfm(1).`doc(1)` - manual pages in commonmarkto `rtfm(1)` - manual pages in commonmark`rtfm(1)` - manual pages in commonmarkto `rtfm(1)` - manual pagesIn my opinion, it would be a good idea to make this two programs, rtfm and a text formatter, where the former calls upon the latter. This would enable other programs to make use of this language.
I agree.
rtfm(1)'s function would be database management; the "find" in find | format | page. Ideally it could be a shell script.
Agreed.