docs: restructure folder

Similar to wrapper-manager subproject, we're just preparing to make this
multi-output for our project's documentation.
This commit is contained in:
Gabriel Arazas 2024-09-04 19:13:39 +08:00
parent 2221ca1642
commit c2da083e5f
No known key found for this signature in database
GPG Key ID: 62104B43D00AA360
62 changed files with 58 additions and 64 deletions

View File

@ -1,8 +0,0 @@
module foo-dogsquared-nixos-config-site
go 1.20
require (
github.com/foo-dogsquared/hugo-theme-more-contentful v0.7.0 // indirect
github.com/foo-dogsquared/website v0.0.0-20230708113620-9c0c493becff // indirect
)

View File

@ -1,9 +0,0 @@
github.com/foo-dogsquared/hugo-mod-simple-icons v0.0.0-20230426231746-ef27600d22f3/go.mod h1:11iN6ArO6sro187xxOeDYAFMENfUNd+Vopn+qqVkCbw=
github.com/foo-dogsquared/hugo-mod-web-feeds v0.0.3-0.20220613123653-e0bc8e58159d/go.mod h1:V7UXom6wuFrWj1lBUCXQA3HguwfDhQA+tQNxyRxdClk=
github.com/foo-dogsquared/hugo-theme-contentful v1.2.1-0.20220513103455-d83c3f8c6954/go.mod h1:BL7L5CENEhUx+miRRaOZ9SVC92j9MAMztirBWtTpiPc=
github.com/foo-dogsquared/hugo-theme-more-contentful v0.7.0 h1:N+U5CshaEko6batgTHa6GBfl2bg/1RbG1dAX6EkndVM=
github.com/foo-dogsquared/hugo-theme-more-contentful v0.7.0/go.mod h1:BpUC3zBnnsil2SkU6bULvcDvAEs6FdDDEM8uB0oCpho=
github.com/foo-dogsquared/website v0.0.0-20230708113620-9c0c493becff h1:SmB7yEWR04EWeZ47oQnCBQtD9ZqAOQv9aQjESyfYBDo=
github.com/foo-dogsquared/website v0.0.0-20230708113620-9c0c493becff/go.mod h1:Wce+DpoP9bp3tTaXFeghknBeJEpnDZ4roiR8qwArSXQ=
github.com/refactoringui/heroicons v2.0.17+incompatible/go.mod h1:82HsLWQga7MkEl5aK8TctxPPIBlXrsyWcVTB57uipuk=
github.com/simple-icons/simple-icons v0.0.0-20230423030844-cd4f7d2bf53c/go.mod h1:oOgUUt8yVYOso/wEBi2ojfZP2MU/xxiNccIpaE+jCvE=

View File

@ -1,19 +0,0 @@
<!DOCTYPE html>
<html lang="{{ .Site.LanguageCode | default "en" }}">
{{ partial "precontent.html" . }}
<head>
{{ partial "head.html" . -}}
{{ partial "head-extended.html" . }}
</head>
<body>
<nav class="book__sidebar" aria-label="Table of contents">
{{ partialCached "chapters.html" . }}
</nav>
<section class="book__content">
{{ partial "header.html" . }}
<hr aria-hidden="true">
{{ block "main" . }}{{ end }}
{{ partial "footer.html" . }}
</section>
</body>
</html>

View File

@ -1,28 +0,0 @@
{ pkgs ? import <nixpkgs> { } }:
with pkgs;
let
asciidoctorWrapper = writeShellScriptBin "asciidoctor" ''
${lib.getBin gems}/bin/asciidoctor -T ${./assets/templates/asciidoctor} $@
'';
gems = bundlerEnv {
name = "nixos-config-project-docs";
ruby = ruby_3_1;
gemdir = ./.;
};
in
mkShell {
packages = [
asciidoctorWrapper
gems
gems.wrappedRuby
bundix
hugo
go
nodePackages.prettier
vscode-langservers-extracted
];
}

8
docs/website/go.mod Normal file
View File

@ -0,0 +1,8 @@
module foo-dogsquared-nixos-config-site
go 1.20
require (
github.com/foo-dogsquared/hugo-theme-more-contentful v0.7.1-0.20240518105144-dd35649b15e2 // indirect
github.com/foo-dogsquared/website v0.0.0-20240609010936-d1a9857559b8 // indirect
)

10
docs/website/go.sum Normal file
View File

@ -0,0 +1,10 @@
github.com/foo-dogsquared/hugo-mod-simple-icons v0.0.0-20231025231637-36998f86bbf2/go.mod h1:8HnVc0SlzI7LCEU4sITYS5MQTq0Bct/nFr/7LdsHYVQ=
github.com/foo-dogsquared/hugo-mod-web-feeds v0.0.3-0.20220613123653-e0bc8e58159d/go.mod h1:V7UXom6wuFrWj1lBUCXQA3HguwfDhQA+tQNxyRxdClk=
github.com/foo-dogsquared/hugo-theme-contentful v1.2.1-0.20220513103455-d83c3f8c6954/go.mod h1:BL7L5CENEhUx+miRRaOZ9SVC92j9MAMztirBWtTpiPc=
github.com/foo-dogsquared/hugo-theme-more-contentful v0.7.1-0.20231028090155-ee19cd7714b4/go.mod h1:RgD3YpinFJyZhtn0iVLNs8eRa0nSs2VA+o1jBpe4zBs=
github.com/foo-dogsquared/hugo-theme-more-contentful v0.7.1-0.20240518105144-dd35649b15e2 h1:BvkVSiI6jXUhUyuRnBY6gSnmb2Th/7FaEwBStbw36Qk=
github.com/foo-dogsquared/hugo-theme-more-contentful v0.7.1-0.20240518105144-dd35649b15e2/go.mod h1:RgD3YpinFJyZhtn0iVLNs8eRa0nSs2VA+o1jBpe4zBs=
github.com/foo-dogsquared/website v0.0.0-20240609010936-d1a9857559b8 h1:a7HWbiHMkcgz6T2lpm4gXHFTljuQ66uHH6YyZdZqeKA=
github.com/foo-dogsquared/website v0.0.0-20240609010936-d1a9857559b8/go.mod h1:zJw9MC6Ajnx5Bom/52LR9Xib40toK9d2tG9FeVqJN3U=
github.com/refactoringui/heroicons v2.0.18+incompatible/go.mod h1:82HsLWQga7MkEl5aK8TctxPPIBlXrsyWcVTB57uipuk=
github.com/simple-icons/simple-icons v0.0.0-20231022005333-fdbaaa2d5f99/go.mod h1:oOgUUt8yVYOso/wEBi2ojfZP2MU/xxiNccIpaE+jCvE=

View File

@ -0,0 +1,22 @@
<!DOCTYPE html>
<html lang="{{ .Site.LanguageCode | default " en" }}">
{{ partial "precontent.html" . }}
<head>
{{ partial "head.html" . -}}
{{ partial "head-extended.html" . }}
</head>
<body>
<nav class="book__sidebar" aria-label="Table of contents">
{{ partialCached "chapters.html" . }}
</nav>
<section class="book__content">
{{ partial "header.html" . }}
<hr aria-hidden="true">
{{ block "main" . }}{{ end }}
{{ partial "footer.html" . }}
</section>
</body>
</html>

18
docs/website/shell.nix Normal file
View File

@ -0,0 +1,18 @@
{ pkgs ? import <nixpkgs> {
overlays = [ (import ../overlays).default ];
} }:
let
site = pkgs.callPackage ./package.nix { };
in
pkgs.mkShell {
inputsFrom = [ site ];
packages = with pkgs; [
bundix
nodePackages.prettier
vscode-langservers-extracted
];
}

View File

Before

Width:  |  Height:  |  Size: 4.8 KiB

After

Width:  |  Height:  |  Size: 4.8 KiB

View File

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

View File

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 26 KiB