diff options
| author | Shahar "Dawn" Or <mightyiampresence@gmail.com> | 2023-07-12 18:50:47 +0700 |
|---|---|---|
| committer | Shahar "Dawn" Or <mightyiampresence@gmail.com> | 2023-07-25 17:03:15 +0700 |
| commit | a064709342b6adfcafe5bdcff3b5ace453359761 (patch) | |
| tree | 53df37db251fc57e72c70fba1ac65f0a0129865a /doc/contributing/contributing-to-documentation.chapter.md | |
| parent | a49d40a00523a9ba6714d91f157c0c764b674230 (diff) | |
| download | nixlib-a064709342b6adfcafe5bdcff3b5ace453359761.tar nixlib-a064709342b6adfcafe5bdcff3b5ace453359761.tar.gz nixlib-a064709342b6adfcafe5bdcff3b5ace453359761.tar.bz2 nixlib-a064709342b6adfcafe5bdcff3b5ace453359761.tar.lz nixlib-a064709342b6adfcafe5bdcff3b5ace453359761.tar.xz nixlib-a064709342b6adfcafe5bdcff3b5ace453359761.tar.zst nixlib-a064709342b6adfcafe5bdcff3b5ace453359761.zip | |
nixpkgs/NixOS manuals: devmode feature
Co-authored-by: Alejandro Sanchez Medina <alejandrosanchzmedina@gmail.com>
Diffstat (limited to 'doc/contributing/contributing-to-documentation.chapter.md')
| -rw-r--r-- | doc/contributing/contributing-to-documentation.chapter.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/contributing/contributing-to-documentation.chapter.md b/doc/contributing/contributing-to-documentation.chapter.md index a732eee4b962..0b7b49bf7dda 100644 --- a/doc/contributing/contributing-to-documentation.chapter.md +++ b/doc/contributing/contributing-to-documentation.chapter.md @@ -23,6 +23,14 @@ $ nix-shell If the build succeeds, the manual will be in `./result/share/doc/nixpkgs/manual.html`. +## devmode {#sec-contributing-devmode} + +The shell in the manual source directory makes available a command, `devmode`. +It is a daemon, that: +1. watches the manual's source for changes and when they occur — rebuilds +2. HTTP serves the manual, injecting a script that triggers reload on changes +3. opens the manual in the default browser + ## Syntax {#sec-contributing-markup} As per [RFC 0072](https://github.com/NixOS/rfcs/pull/72), all new documentation content should be written in [CommonMark](https://commonmark.org/) Markdown dialect. |