actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
mdBook/test_book/src
History
Jacek Sieka 5c8941ba16 Add Nim to default languages 
Nim is a systems programming language (included in the highlight.js
`system` group), and we're quite happily using `mdBook` in several of
our documentation projects starting with our [style
guide](https://status-im.github.io/nim-style-guide/).

While we can maintain our own highlight.js, including `Nim` in the
default distribution would allow us to promote more mdBook usage in the
Nim community at the cost of a ~2kb increase in the `highlight.js` size.
 		2023-11-08 15:34:35 +01:00
..
individual Add proper test to inline code within the book. 2023-09-02 14:38:02 -07:00
languages Add Nim to default languages 2023-11-08 15:34:35 +01:00
rust Add rust specific codeblock examples 2021-10-05 12:11:29 +05:30
README.md Setup basic structure for test book 2021-10-04 13:14:49 +05:30
SUMMARY.md Add rust specific codeblock examples 2021-10-05 12:11:29 +05:30
prefix.md Setup basic structure for test book 2021-10-04 13:14:49 +05:30
suffix.md Setup basic structure for test book 2021-10-04 13:14:49 +05:30

README.md

Demo Book

This is a simple demo book, which is intended to be used for verifying and validating style changes in mdBook. This contains dummy examples of various markdown elements and code languages, so that one can check changes made in mdBook styles.

This rough outline is :

  • individual : contains basic markdown elements such as headings, paragraphs, links etc.
  • languages : contains a hello world in each of supported language to see changes in syntax highlighting
  • rust : contains language examples specific to rust, such as play pen, runnable examples etc.

This is more for checking and fixing style, rather than verifying that correct code is generated for given markdown, that is better handled in tests.