Skip to content

"Rust Book"-style introduction and documentation for Kinode OS

License

Notifications You must be signed in to change notification settings

0xlynett/kinode-book

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kinode Book

"Rust Book"-style introduction and documentation for Kinode OS.

To build:

cargo install mdbook

mdbook serve

Navigate to http://localhost:3000 to view.

Conventions

  1. Prefer the triple-backtick ("`") codeblocks to single-backtick lines when writing code intended to be copied. This is more readable and easy to use for readers following along by copy-pasting commands.
  2. Each line in a paragraph should be on a newline. When compiled, markdown places these lines into a single paragraph: separate paragraphs must be separated by two newlines. Thus, from the reader's perspective, there is no difference. From the editor's and reviewer's perspective, though, it is much easier to read diffs of prose that are per-sentence rather than per-paragraph.
  3. Do not use "double dashes" in prose (--). Instead use "em dashes" ().

About

"Rust Book"-style introduction and documentation for Kinode OS

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 43.1%
  • JavaScript 35.2%
  • Handlebars 21.7%