diff --git a/.gitignore b/.gitignore index 67baa4f6..ad1190d4 100644 --- a/.gitignore +++ b/.gitignore @@ -11,6 +11,7 @@ result* /pkgs/clan-cli/clan_cli/webui/assets nixos.qcow2 **/*.glade~ +/docs/out # python __pycache__ diff --git a/docs/.envrc b/docs/.envrc index 18267144..293e9919 100644 --- a/docs/.envrc +++ b/docs/.envrc @@ -1,6 +1,6 @@ source_up -watch_file flake-module.nix shell.nix default.nix +watch_file nix/flake-module.nix nix/shell.nix nix/default.nix # Because we depend on nixpkgs sources, uploading to builders takes a long time use flake .#docs --builders '' diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index d823e3fb..00000000 --- a/docs/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -# build oputputs -site \ No newline at end of file diff --git a/docs/docs/contributing.md b/docs/contributing.md similarity index 100% rename from docs/docs/contributing.md rename to docs/contributing.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index deaa2f58..bb05a353 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -9,8 +9,6 @@ validation: absolute_links: warn unrecognized_links: warn -markdown_extensions: - markdown_extensions: - pymdownx.tasklist: custom_checkbox: true @@ -41,7 +39,10 @@ nav: - Backup & Restore: getting-started/backups.md - Flake-parts: getting-started/flake-parts.md - Templates: templates/index.md - - Contributing: contributing.md + - Contributing: contributing/contributing.md + +docs_dir: site +site_dir: out theme: logo: static/logo.png @@ -72,8 +73,5 @@ theme: icon: material/weather-sunny name: Switch to light mode -extra_css: - - stylesheets/extra.css - plugins: - search diff --git a/docs/flake-module/default.nix b/docs/modules/default.nix similarity index 100% rename from docs/flake-module/default.nix rename to docs/modules/default.nix diff --git a/docs/flake-module/zola-pages.nix b/docs/modules/zola-pages.nix similarity index 100% rename from docs/flake-module/zola-pages.nix rename to docs/modules/zola-pages.nix diff --git a/docs/default.nix b/docs/nix/default.nix similarity index 95% rename from docs/default.nix rename to docs/nix/default.nix index ce218538..b310b9db 100644 --- a/docs/default.nix +++ b/docs/nix/default.nix @@ -2,7 +2,7 @@ pkgs.stdenv.mkDerivation { name = "clan-documentation"; - src = ./.; + src = ../.; nativeBuildInputs = [ pkgs.python3 ] diff --git a/docs/deploy-docs.nix b/docs/nix/deploy-docs.nix similarity index 100% rename from docs/deploy-docs.nix rename to docs/nix/deploy-docs.nix diff --git a/docs/flake-module.nix b/docs/nix/flake-module.nix similarity index 100% rename from docs/flake-module.nix rename to docs/nix/flake-module.nix diff --git a/docs/shell.nix b/docs/nix/shell.nix similarity index 100% rename from docs/shell.nix rename to docs/nix/shell.nix diff --git a/docs/site/contributing/contributing.md b/docs/site/contributing/contributing.md new file mode 120000 index 00000000..6a71ba56 --- /dev/null +++ b/docs/site/contributing/contributing.md @@ -0,0 +1 @@ +../../contributing.md \ No newline at end of file diff --git a/docs/docs/drafts/install-iso.md b/docs/site/drafts/install-iso.md similarity index 100% rename from docs/docs/drafts/install-iso.md rename to docs/site/drafts/install-iso.md diff --git a/docs/docs/getting-started/backups.md b/docs/site/getting-started/backups.md similarity index 100% rename from docs/docs/getting-started/backups.md rename to docs/site/getting-started/backups.md diff --git a/docs/docs/getting-started/flake-parts.md b/docs/site/getting-started/flake-parts.md similarity index 100% rename from docs/docs/getting-started/flake-parts.md rename to docs/site/getting-started/flake-parts.md diff --git a/docs/docs/getting-started/installer.md b/docs/site/getting-started/installer.md similarity index 100% rename from docs/docs/getting-started/installer.md rename to docs/site/getting-started/installer.md diff --git a/docs/docs/getting-started/machines.md b/docs/site/getting-started/machines.md similarity index 99% rename from docs/docs/getting-started/machines.md rename to docs/site/getting-started/machines.md index 8053f2f2..12669507 100644 --- a/docs/docs/getting-started/machines.md +++ b/docs/site/getting-started/machines.md @@ -109,7 +109,7 @@ clan machines install my-machine > Note: This may take a while for building and for the file transfer. -#### 🎉 🚀 Your machine is all set up +🎉 🚀 Your machine is all set up --- diff --git a/docs/docs/getting-started/networking.md b/docs/site/getting-started/networking.md similarity index 100% rename from docs/docs/getting-started/networking.md rename to docs/site/getting-started/networking.md diff --git a/docs/docs/getting-started/secrets.md b/docs/site/getting-started/secrets.md similarity index 100% rename from docs/docs/getting-started/secrets.md rename to docs/site/getting-started/secrets.md diff --git a/docs/docs/index.md b/docs/site/index.md similarity index 100% rename from docs/docs/index.md rename to docs/site/index.md diff --git a/docs/docs/static/logo.png b/docs/site/static/logo.png similarity index 100% rename from docs/docs/static/logo.png rename to docs/site/static/logo.png diff --git a/docs/docs/templates/index.md b/docs/site/templates/index.md similarity index 100% rename from docs/docs/templates/index.md rename to docs/site/templates/index.md diff --git a/flake.nix b/flake.nix index b7cc3f3e..e81b3d21 100644 --- a/flake.nix +++ b/flake.nix @@ -40,7 +40,7 @@ ./devShell.nix # TODO: migrate this @davHau # ./docs/flake-module - ./docs/flake-module.nix + ./docs/nix/flake-module.nix ./formatter.nix ./lib/flake-module.nix ./nixosModules/flake-module.nix