feat($lib/docs): introduce new docs pipeline #8

ckie · 2024-10-27T02:10:47Z

ckie commented

2024-10-27 02:10:47 +00:00

TODO for merge

the petalpkgs input takes ~50 min to clone
vite insists on iterating through the entire .petalpkgs file tree.
code review
minimal styling rn, leaving that to jake if they'll have it || @tailwindcss/typography

### TODO for merge - [ ] the petalpkgs input takes ~50 min to clone - [X] vite insists on iterating through the entire `.petalpkgs` file tree. - [ ] code review - [X] minimal styling rn, leaving that to jake if they'll have it || `@tailwindcss/typography`

ckie added 4 commits 2024-10-27 02:10:52 +00:00

feat(flake): make petalpkgs src available for docs 4de208543c

chore(svelte.config): switch to adapter-node b9b3d2880c

feat($lib/docs): introduce new docs pipeline abe45c4ade

fix(vite.config): also ignore .direnv 35123ba4a7

ckie reviewed 2024-10-27 02:13:44 +00:00

src/lib/docs/remark-include.ts

					
				@ -0,0 +11,4 @@

				import type { Node, Root, Code } from "mdast";

				import type { Plugin } from "unified";

				export const remarkInclude: Plugin<[], Root> = ({ resolveFrom }: { resolveFrom: string }) => {

ckie commented

2024-10-27 02:11:44 +00:00

eventually fix TS complaints
remark-include.ts 14 14 error 2322 Type '({ resolveFrom }: { resolveFrom: string; }) => (tree: any, file: any) => any' is not assignable to type 'Plugin<[], Root>'.

eventually fix TS complaints `remark-include.ts 14 14 error 2322 Type '({ resolveFrom }: { resolveFrom: string; }) => (tree: any, file: any) => any' is not assignable to type 'Plugin<[], Root>'.`

src/lib/docs/remark-include.ts

					
				@ -0,0 +22,4 @@

							// !== "options" because those are special, parsed from options.json:

							// https://github.com/NixOS/nixpkgs/blob/d31617bedffa3e5fe067feba1c68b1a7f644cb4f/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual.py#L81-L102

							console.log("awa", node);

ckie commented

2024-10-27 02:11:08 +00:00

remove

src/lib/docs/remark-include.ts

					
				@ -0,0 +34,4 @@

									includeContents = readSync(includePath, "utf8");

								} catch (err) {

									throw new Error(

										`The @include file path at ${includePath} was not found.\n\nInclude Location: ${file.path}:${node.position.start.line}:${node.position.start.column}`

ckie commented

2024-10-27 02:11:04 +00:00

update msg

src/lib/docs/remark-include.ts

					
				@ -0,0 +53,4 @@

									// trim trailing newline

									includeContents.contents = includeContents.contents.trim();

									// return contents wrapped inside a "code" node

ckie commented

2024-10-27 02:13:34 +00:00

it renders fine regardless but this is 100% wrong, copy-paste error.

ckie requested review from jakehamilton 2024-10-27 02:14:00 +00:00

This pull request can be merged automatically.

You are not authorized to merge this pull request.

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin ckie/init/docs:ckie/init/docs

git checkout ckie/init/docs

Merge

Merge the changes and update on Forgejo.

git checkout main

git merge --no-ff ckie/init/docs

git checkout main

git merge --ff-only ckie/init/docs

git checkout ckie/init/docs

git rebase main

git checkout main

git merge --no-ff ckie/init/docs

git checkout main

git merge --squash ckie/init/docs

git checkout main

git merge --ff-only ckie/init/docs

git checkout main

git merge ckie/init/docs

git push origin main

Sign in to join this conversation.

No reviewers

No labels

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: the-distro/floral.systems#8