From 0357141fbcd1a2c7deb1efd7e5b5953c87f15fdb Mon Sep 17 00:00:00 2001 From: sammyette Date: Wed, 14 Dec 2022 21:05:11 -0400 Subject: [PATCH] docs: fix yaml metadata, symlink to hugo --- cmd/docgen/docgen.go | 7 +++++-- docs/api/_index.md | 7 +++++++ docs/api/bait.md | 7 +++++-- docs/api/commander.md | 7 +++++-- docs/api/fs.md | 7 +++++-- docs/api/hilbish/_index.md | 7 +++++-- docs/api/hilbish/hilbish.aliases.md | 7 +++++-- docs/api/hilbish/hilbish.completions.md | 7 +++++-- docs/api/hilbish/hilbish.history.md | 7 +++++-- docs/api/hilbish/hilbish.jobs.md | 7 +++++-- docs/api/hilbish/hilbish.os.md | 7 +++++-- docs/api/hilbish/hilbish.runner.md | 7 +++++-- docs/api/hilbish/hilbish.timers.md | 7 +++++-- docs/api/hilbish/hilbish.userDir.md | 7 +++++-- docs/api/terminal.md | 7 +++++-- website/content/docs/api | 1 + 16 files changed, 78 insertions(+), 28 deletions(-) create mode 100644 docs/api/_index.md create mode 120000 website/content/docs/api diff --git a/cmd/docgen/docgen.go b/cmd/docgen/docgen.go index f78c4c6..4072023 100644 --- a/cmd/docgen/docgen.go +++ b/cmd/docgen/docgen.go @@ -13,9 +13,12 @@ import ( ) var header = `--- -name: %s %s +title: %s %s description: %s -layout: apidoc +layout: doc +menu: + docs: + parent: "API" --- ` diff --git a/docs/api/_index.md b/docs/api/_index.md new file mode 100644 index 0000000..5c8b722 --- /dev/null +++ b/docs/api/_index.md @@ -0,0 +1,7 @@ +--- +title: API +layout: doc +weight: -50 +menu: docs +--- + diff --git a/docs/api/bait.md b/docs/api/bait.md index 2eaaffe..fdf22b0 100644 --- a/docs/api/bait.md +++ b/docs/api/bait.md @@ -1,7 +1,10 @@ --- -name: Module bait +title: Module bait description: the event emitter -layout: apidoc +layout: doc +menu: + docs: + parent: "API" --- ## Introduction diff --git a/docs/api/commander.md b/docs/api/commander.md index 379ecba..e3e5320 100644 --- a/docs/api/commander.md +++ b/docs/api/commander.md @@ -1,7 +1,10 @@ --- -name: Module commander +title: Module commander description: library for custom commands -layout: apidoc +layout: doc +menu: + docs: + parent: "API" --- ## Introduction diff --git a/docs/api/fs.md b/docs/api/fs.md index 3800422..6ad11de 100644 --- a/docs/api/fs.md +++ b/docs/api/fs.md @@ -1,7 +1,10 @@ --- -name: Module fs +title: Module fs description: filesystem interaction and functionality library -layout: apidoc +layout: doc +menu: + docs: + parent: "API" --- ## Introduction diff --git a/docs/api/hilbish/_index.md b/docs/api/hilbish/_index.md index ab2aa0a..ae11539 100644 --- a/docs/api/hilbish/_index.md +++ b/docs/api/hilbish/_index.md @@ -1,7 +1,10 @@ --- -name: Module hilbish +title: Module hilbish description: the core Hilbish API -layout: apidoc +layout: doc +menu: + docs: + parent: "API" --- ## Introduction diff --git a/docs/api/hilbish/hilbish.aliases.md b/docs/api/hilbish/hilbish.aliases.md index 3c31113..1ff766c 100644 --- a/docs/api/hilbish/hilbish.aliases.md +++ b/docs/api/hilbish/hilbish.aliases.md @@ -1,7 +1,10 @@ --- -name: Interface hilbish.aliases +title: Interface hilbish.aliases description: command aliasing -layout: apidoc +layout: doc +menu: + docs: + parent: "API" --- ## Introduction diff --git a/docs/api/hilbish/hilbish.completions.md b/docs/api/hilbish/hilbish.completions.md index 2f17d1d..bcfd2f9 100644 --- a/docs/api/hilbish/hilbish.completions.md +++ b/docs/api/hilbish/hilbish.completions.md @@ -1,7 +1,10 @@ --- -name: Interface hilbish.completions +title: Interface hilbish.completions description: tab completions -layout: apidoc +layout: doc +menu: + docs: + parent: "API" --- ## Introduction diff --git a/docs/api/hilbish/hilbish.history.md b/docs/api/hilbish/hilbish.history.md index f20aaef..f297ab2 100644 --- a/docs/api/hilbish/hilbish.history.md +++ b/docs/api/hilbish/hilbish.history.md @@ -1,7 +1,10 @@ --- -name: Interface hilbish.history +title: Interface hilbish.history description: command history -layout: apidoc +layout: doc +menu: + docs: + parent: "API" --- ## Introduction diff --git a/docs/api/hilbish/hilbish.jobs.md b/docs/api/hilbish/hilbish.jobs.md index 49962e6..b180dd4 100644 --- a/docs/api/hilbish/hilbish.jobs.md +++ b/docs/api/hilbish/hilbish.jobs.md @@ -1,7 +1,10 @@ --- -name: Interface hilbish.jobs +title: Interface hilbish.jobs description: background job management -layout: apidoc +layout: doc +menu: + docs: + parent: "API" --- ## Introduction diff --git a/docs/api/hilbish/hilbish.os.md b/docs/api/hilbish/hilbish.os.md index d778dd7..aa2198e 100644 --- a/docs/api/hilbish/hilbish.os.md +++ b/docs/api/hilbish/hilbish.os.md @@ -1,7 +1,10 @@ --- -name: Interface hilbish.os +title: Interface hilbish.os description: OS Info -layout: apidoc +layout: doc +menu: + docs: + parent: "API" --- ## Introduction diff --git a/docs/api/hilbish/hilbish.runner.md b/docs/api/hilbish/hilbish.runner.md index 0b074b4..68ffdc6 100644 --- a/docs/api/hilbish/hilbish.runner.md +++ b/docs/api/hilbish/hilbish.runner.md @@ -1,7 +1,10 @@ --- -name: Interface hilbish.runner +title: Interface hilbish.runner description: interactive command runner customization -layout: apidoc +layout: doc +menu: + docs: + parent: "API" --- ## Introduction diff --git a/docs/api/hilbish/hilbish.timers.md b/docs/api/hilbish/hilbish.timers.md index 2b29709..60bedb5 100644 --- a/docs/api/hilbish/hilbish.timers.md +++ b/docs/api/hilbish/hilbish.timers.md @@ -1,7 +1,10 @@ --- -name: Interface hilbish.timers +title: Interface hilbish.timers description: timeout and interval API -layout: apidoc +layout: doc +menu: + docs: + parent: "API" --- ## Introduction diff --git a/docs/api/hilbish/hilbish.userDir.md b/docs/api/hilbish/hilbish.userDir.md index 1fd37d1..0b95057 100644 --- a/docs/api/hilbish/hilbish.userDir.md +++ b/docs/api/hilbish/hilbish.userDir.md @@ -1,7 +1,10 @@ --- -name: Interface hilbish.userDir +title: Interface hilbish.userDir description: user-related directories -layout: apidoc +layout: doc +menu: + docs: + parent: "API" --- ## Introduction diff --git a/docs/api/terminal.md b/docs/api/terminal.md index f1007d8..99d4b49 100644 --- a/docs/api/terminal.md +++ b/docs/api/terminal.md @@ -1,7 +1,10 @@ --- -name: Module terminal +title: Module terminal description: low level terminal library -layout: apidoc +layout: doc +menu: + docs: + parent: "API" --- ## Introduction diff --git a/website/content/docs/api b/website/content/docs/api new file mode 120000 index 0000000..1c5c360 --- /dev/null +++ b/website/content/docs/api @@ -0,0 +1 @@ +../../../docs/api/ \ No newline at end of file