Commit graph

57 commits

Author SHA1 Message Date
Daniel Thwaites
f403ca101e
doc: split modules into separate pages (#873) 2025-02-23 15:50:41 +00: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
4c04e0dece
doc: redirect old reference pages to new location 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
99096ef3e3
doc: clarify global option
Co-authored-by: NAHO <90870942+trueNAHO@users.noreply.github.com>
2025-02-23 15:20:11 +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
7afc6fb46d
doc: describe how to create module documentation 2025-02-19 13:45:27 +00:00
Daniel Thwaites
aeb550add3
doc: remove site-url setting (#878)
Since the documentation is now hosted at https://stylix.danth.me/ rather
than https://danth.github.io/stylix/, this setting is no longer
necessary.

Reviewed-by: NAHO <90870942+trueNAHO@users.noreply.github.com>
2025-02-18 21:06:11 +01:00
Daniel Thwaites
d6796ff307
doc: fix some alerts not being rendered by substituteInPlace 2025-02-18 14:38:27 +00:00
Daniel Thwaites
de2057a000
doc: disable section numbers
Due to new module pages being added fairly often, the section numbers
won't be stable, so they provide little benefit.
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
211a8440e7
stylix: support multiple testbeds per module (#858)
Support multiple testbeds per module with
/modules/<MODULE>/testbeds/<TESTBED>.nix, while validating various
invariants.
2025-02-17 12:56:46 +00:00
NAHO
7818098f4d
treewide: remove trailing whitespaces and add trailing newline (#841) 2025-02-08 22:20:10 +01:00
Alex Friedman
6103431cd2
doc: Update tricks per tinted-theming schema changes (#792)
The tinted-theming repository has updated its scheme for themes such
that colors are located under the key `palette` [1] and such that each
color is # prefixed [2]. These changes update the documentation to
reflect this new schema.


[1]
4caed9a8f5
[2]
61058a8d2e
2025-01-26 22:28:40 +00:00
NAHO
58b54b664b
doc: elaborate pre-commit hook usage in development environment (#793) 2025-01-25 19:21:13 +00:00
pancho horrillo
fb773084f7
doc: fix two titles not using sentence case (#769)
The style of these two were inconsistent with the rest of the
documentation corpus.

Link: https://github.com/danth/stylix/pull/769

Reviewed-by: Daniel Thwaites <danth@danth.me>
Reviewed-by: NAHO <90870942+trueNAHO@users.noreply.github.com>
2025-01-12 19:34:45 +01: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
5ab7d0345a
treewide: add and apply typos pre-commit hook
Link: https://github.com/danth/stylix/pull/519
2025-01-04 17:45:52 +01:00
NAHO
6ef37ca6aa
treewide: leverage direnv to automatically enter developer shell
Leverage direnv [1] to automatically enter the developer shell upon
entering the project directory after running 'direnv allow'.

[1]: https://direnv.net

Link: https://github.com/danth/stylix/pull/519
2025-01-04 17:45:52 +01:00
NAHO
703f49aaca
treewide: add developer shell
Link: https://github.com/danth/stylix/pull/519
2025-01-04 17:45:52 +01:00
Daniel Thwaites
7c8874b311
doc: remove "below" which was moved to a separate page (#727) 2025-01-04 15:55:13 +00:00
Daniel Thwaites
18fd600cd2
doc: draw attention to release branches (#726)
Using the wrong branch is a very common cause of questions, due to it
not being mentioned anywhere in the documentation.
2025-01-04 15:48:43 +00:00
FirelightFlagboy
a70154ec03
doc: resolve 'magick convert' deprecation warning (#697)
Resolve the following 'magick convert' deprecation warning:

    WARNING: The convert command is deprecated in IMv7, use "magick"
    instead of "convert" or "magick convert"

Reviewed-by: NAHO <90870942+trueNAHO@users.noreply.github.com>
2024-12-25 18:43:53 +01:00
NAHO
dd6605be79
doc: encourage adding testbeds for new modules (#673)
This follows the discussion at
https://github.com/danth/stylix/pull/612#issuecomment-2532155680
2024-12-10 18:14:48 +00:00
NAHO
81148743b9
doc: remove documentation about legacy commit conventions (#672)
Remove legacy documentation about commit message conventions predating
the standardized format introduced in commit bf31640f49 ("doc: specify
commit message format") on 2024-01-23, with the final GitMoji usage in
commit 5a7f3f15cc ("Add guide for creating modules 📝").
2024-12-10 18:12:25 +00:00
Alexey Lebedeff
9b61cc39b2
stylix: don't split autoloaded modules into a separate derivation (#631)
Apparently `../modules` is creating a separate derivation that contains
only that folder, so it's now separate from the flake source. But this
transient derivation isn't mentioned explicitly anywhere in the flake
outputs. It makes it impossible to target those modules in
`disabledModules` directive.

For example, after this change is applied, users can solve issues like
https://github.com/danth/stylix/issues/577 locally, by just adding the
following snippet to their configuration:

    disabledModules = [ "${inputs.stylix}/modules/regreet/nixos.nix" ];

Reviewed-by: Daniel Thwaites <danthwaites30@btinternet.com>
Reviewed-by: NAHO <90870942+trueNAHO@users.noreply.github.com>
2024-11-17 17:40:52 +01:00
NAHO
9b5a65b681
doc: extract Commit Convention section (#518) 2024-08-23 20:31:39 +01:00
Gabriel Talbert Bunt
feb2973dfa
doc: specify correct color attribute path (#491)
Colors are accessible under config.lib.stylix.colors, not lib.stylix.colors.

Co-authored-by: NAHO <90870942+trueNAHO@users.noreply.github.com>
2024-07-30 00:21:31 +01:00
Will Bush
6f36b27afd
doc: update tinted-theming repo link (#476)
> The 'base16-schemes' package uses the 'tinted-theming/base16-schemes'
> repository, which has now been archived by the owner in favor of
> 'tinted-theming/schemes'
>
> -- https://github.com/NixOS/nixpkgs/issues/285671
2024-07-20 14:33:22 +02:00
Daniel Thwaites
f060e4059b
stylix: clean up fromOs (#407) 2024-06-11 03:21:04 +02: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
diniamo
f0ddd45fbe
treewide: change window manager style guide (#414) 2024-06-08 16:17:58 +01:00
Artem
e7543c51ef
doc: fix link for "Installing Home Manager as a NixOS module" (#385)
Co-authored-by: Art <art@MacBook-Pro-Art.local>
2024-05-22 17:39:29 +01:00
Daniel Thwaites
23cbb96638
doc: refresh screenshots (#382) 2024-05-22 16:54:19 +01:00
head-gardener
76e7daf5a1
doc: explain using lib.stylix.colors (#328)
The attrset is used heavily in styllix's modules, but the docs don't contain even a top-level explanation of its value. Though you can gather most it from skimming `base16.nix`, I think stylix should provide an entry point for users, interested in using their color schemes outside of stylix. I base this assumption on personal anecdote of people not having a good understanding of exported values even after extended usage and implementing parallel parsing logic for color scheme files.
2024-05-18 14:01:01 +01:00
NACAMURA Mitsuhiro
f83376bfdc
doc: update NixOS wiki link (#363) 2024-05-11 12:39:19 +01:00
Daniel Thwaites
267cf91e03
doc: add documentation for testbeds (#347)
Co-authored-by: NAHO <90870942+trueNAHO@users.noreply.github.com>
2024-04-22 14:37:29 +01:00
head-gardener
58761b51f8
doc: add mention of lib.stylix.pixel to tricks (#327)
The function implements a fairly popular feature and is pretty old, but never gets mentioned in the docs. In fact, I only found it by randomly going through the sources. As a result, a person I spoke to wrote the section above describing a re-implementation of the function, which does work but doesn't need to be the default approach.

This change will improve discoverability of the codebase and direct users to a more standardized implementation.

P.S. `base16-schemes` changed `catppuccin.yaml` to a couple of variant themes, which is represented in this commit.
2024-04-10 16:46:34 +01:00
Daniel Thwaites
edf739eeb3
doc: change selection background to base02 (#290)
Closes #277. See the issue for more details.
2024-03-18 00:37:44 +00:00
NAHO
1a5dee1957
treewide: remove tailing whitespaces (#228) 2024-01-25 08:45:05 +00: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
5a7f3f15cc
Add guide for creating modules 📝
Closes #101
2023-12-29 20:06:23 +00:00
Ascii Moth
c29f2e6f9d
Add trick with dynamic wallpaper generation (#135) 2023-07-29 09:50:28 +01:00
Mason Dear
0015e56326
Create style guide (#90)
Co-authored-by: Daniel Thwaites <danthwaites30@btinternet.com>
2023-06-13 19:45:23 +00:00
pancho horrillo
95fd9afebd
Fix module name in docs (#91) 2023-04-24 08:22:25 +00:00
Daniel Thwaites
d2937609ba
Fix typo in installtion docs ✏️ 2023-03-31 19:46:56 +01:00
Daniel Thwaites
ff3ac315ab
Edit colour schemes section in docs 📝
The Tinted Theming repository is now packaged in Nixpkgs, so we
don't need to list other ways to obtain it.

Also simplified the links to the preview as `$XDG_CONFIG_HOME`
is rarely modified.
2023-03-31 19:40:16 +01:00
Daniel Thwaites
a3f9fa981b
Convert documentation to mdBook 📝 🔨 2023-03-29 00:54:14 +01:00