add markdown.md and markdown.html

Add `markdown.md` which generates `markdown.html`
to document IOCCC markdown best practices.

Changed `bin/gen-top-html.sh` VERSION from to "1.4.1 2024-04-16"
to "1.4.2 2024-04-21".

Added FAQ 0.6 about IOCCC mark requirements.

Run `make gen_top_html timestamp` to perform the above.
This commit is contained in:
Landon Curt Noll committed 2024-04-21 02:54:54 -07:00
1 parent be3ea780a4
commit bb19f88222
7 files changed
+552 -5

No files matched your search

+22
View File
@@ -8,6 +8,7 @@
- [0.3 - May I use a different source or compiled filename than prog.c or prog?](#faq0_3)
- [0.4 - What platform should I assume for my entry?](#faq0_4)
- [0.5 - How may I comment or make a suggestion on IOCCC rules, guidelines and tools?](#faq0_5)
- [0.6 - What are the IOCCC requirements for using markdown?](#faq0_6)
## Section 1 - [History of the IOCCC](#faq1)
@@ -408,6 +409,27 @@ discussion with the [IOCCC judges](judges.html), then see
[How to contact the IOCCC](contact.html).
<div id="faq0_6">
<div id="markdown">
### FAQ 0.6: - What are the IOCCC requirements for using markdown?
</div>
</div>
The IOCCC makes extensive use of [markdown](https://daringfireball.net/projects/markdown/).
For example, we [submitting to the IOCCC](faq.html#submit), we have people
to submit remarks about entry in markdown format. Every
[winning IOCCC entry](years.html) uses a `README.md` markdown file
as the basis for forming the `index.html` web page for that entry.
All generated HTML pages on the [Official IOCCC web site](https://www.ioccc.org/index.html)
start with some markdown content.
**IMPORTANT**: Please read the [IOCCC markdown best practices](markdown.html) guide
as it lists things you **should not use** in markdown files.
See the [markdown syntax](https://www.markdownguide.org/basic-syntax) guide.
See also [CommonMark Spec](https://spec.commonmark.org/current/).
<div id="faq1">
## Section 1: History of the IOCCC
</div>