Commit graph

24 commits

Author SHA1 Message Date
Daniel Thwaites
aee4df6dc1
doc: add link to CommonMark Spec (#1081) 2025-04-02 07:26:00 -07:00
Daniel Thwaites
a55488c247
doc: reduce overuse of alerts (#1041)
Using too many "info" and "warning" boxes makes them less effective when
they're needed to draw attention to something genuinely important.

This commit adds important boxes to modules which require an external
module to be imported, similar to the box already used on the "Firefox and
derivatives" page.

It changes the warning when a module has no maintainers to a regular
paragraph.

The note about `stylix.enable` being new is removed, since this has been
around for a while now.
2025-03-23 13:25:15 +00:00
Daniel Thwaites
f537d507c3
doc: add subheading before module metadata (#1042)
This avoids the metadata looking like part of a README subheading.
2025-03-23 13:23:39 +00:00
Daniel Thwaites
64b4369b6b
doc: display module maintainers (#1010)
As promised at
https://github.com/danth/stylix/pull/977#pullrequestreview-2683388232,
this lists the maintainers for each module on its page in the docs.

This includes some fixes to `stylix/meta.nix`: swapped the order of
arguments to `mapAttrs`, and added an `import` to load the meta file
rather than returning its path.
2025-03-20 16:05:36 +00:00
Daniel Thwaites
52b1cc7247
doc: implement custom option list generation (#955)
Implement a custom option list generation with a pkgs.nixosOptionsDoc
variant that evaluates each platform configuration only once.

This resolves [1] ("doc: avoid excessive calls to pkgs.nixosOptionsDoc")
and unblocks [2] ("ci: too many matrix jobs").

With the gained flexibility, option details are now rendered as tables.

[1]: https://github.com/danth/stylix/issues/896
[2]: https://github.com/danth/stylix/issues/947

Closes: https://github.com/danth/stylix/issues/896
Link: https://github.com/danth/stylix/pull/955

Reviewed-by: NAHO <90870942+trueNAHO@users.noreply.github.com>
2025-03-14 19:04:49 +01:00
Daniel Thwaites
1398fc4dc8
doc: use permalinks for option declarations 2025-02-23 15:20:12 +00:00
NAHO
f4401071ea
doc: add declaration entry 2025-02-23 15:20:12 +00:00
Daniel Thwaites
2b2f260a69
doc: collapse platforms and modules
Collapsing is only possible for pages, not headings, so I had to
combine platforms and modules into a single section and nest them
under draft pages.

Later, we could migrate some content from the configuration page to
these draft pages to make the flow of the book more natural.
2025-02-23 15:20:12 +00:00
Daniel Thwaites
13667122ec
doc: standardize Bash code
Co-authored-by: NAHO <90870942+trueNAHO@users.noreply.github.com>
2025-02-23 15:20:11 +00:00
Daniel Thwaites
472bd50c85
doc: store module documentation as a README within the module
This has two benefits:

1. It will be displayed when browsing the module source code on
   GitHub.
2. It prevents the documentation inadvertently disappearing if the
   module directory is renamed.
2025-02-19 13:45:27 +00:00
Daniel Thwaites
d6796ff307
doc: fix some alerts not being rendered by substituteInPlace 2025-02-18 14:38:27 +00:00
Daniel Thwaites
77e58881df
doc: split modules into individual pages 2025-02-18 14:38:27 +00:00
NAHO
ad64260a75
treewide: add and apply nixfmt pre-commit hook
Link: https://github.com/danth/stylix/pull/519
2025-01-04 17:48:26 +01:00
NAHO
9b5a65b681
doc: extract Commit Convention section (#518) 2024-08-23 20:31:39 +01:00
Jalil David Salamé Messina
7682713f6a
stylix: add 'stylix.enable' option (#244)
Add a 'stylix.enable' option to enable or disable all Stylix modules in
order to resolve issues similar to [2].

To align with the default 'lib.mkEnableOption' [1] behavior,
'stylix.enable' defaults to 'false'.

BREAKING CHANGE: Stylix is disabled by default. To enable it, use:

    stylix.enable = true;

[1]: https://github.com/NixOS/nixpkgs/blob/23.11/lib/options.nix#L91-L105
[2]: https://github.com/danth/stylix/issues/216

Co-authored-by: Daniel Thwaites <danthwaites30@btinternet.com>
Co-authored-by: Jalil David Salamé Messina <jalil.salame@gmail.com>
Co-authored-by: NAHO <90870942+trueNAHO@users.noreply.github.com>
2024-06-10 11:52:47 +02:00
Daniel Thwaites
23cbb96638
doc: refresh screenshots (#382) 2024-05-22 16:54:19 +01:00
Daniel Thwaites
bf31640f49
doc: specify commit message format
I've noticed quite a few pull requests are being submitted with formats
such as feat(abc): or target: at the start of the message.

It will be helpful to have a specific format for this to keep things
consistent.
2024-01-23 21:06:14 +00:00
Daniel Thwaites
a3f9fa981b
Convert documentation to mdBook 📝 🔨 2023-03-29 00:54:14 +01:00
SnIcK
dd7fc590c3
Add FAQ.md (#52)
Co-authored-by: Daniel Thwaites <danthwaites30@btinternet.com>
2023-03-02 09:49:44 +00:00
Daniel Thwaites
c9bf0c8099
Improve documentation about the NixOS/Home Manager split 📝
Related to the discussion in #25
2023-02-14 14:46:41 +00:00
Daniel Thwaites
939669577c
Remove Haddock pages from website 📝
This was more of a developer tool than part of the documentation, so it
makes sense to keep it off the main site. Also when modifying the
palette generator, the documentation on the site would become out of
sync with local changes anyway.
2023-02-13 20:09:56 +00:00
Daniel Thwaites
6fa03db360
Generate documentation for NixOS and Home Manager options 📝 2023-02-04 12:07:06 +00:00
Daniel Thwaites
7794dbe521
Update Coricamu ⬆️ 2022-07-31 14:35:18 +01:00
Daniel Thwaites
0ea346a423
Publish list of NixOS options on GitHub Pages 📝 2022-07-30 15:31:58 +01:00