mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-04 09:15:33 +00:00
Add documentation for gt, the Gitea CLI (#603)
Adds a CLI product for gt (https://gitea.com/gitea/cli), set up like the runner, with short guides for installation, logging in, CI and scripting. Each command's details stay in gt <command> --help. Until the first release, the docs are served at /cli/; make cut-version PRODUCT=cli VERSION=0.1 adds the release series. Closes https://gitea.com/gitea/cli/issues/16 <!-- cloudflare-preview --> Preview: https://pr-603.docs-gitea-com.pages.dev --------- Co-authored-by: silverwind <[email protected]> Reviewed-on: https://gitea.com/gitea/docs/pulls/603 Reviewed-by: Lunny Xiao <[email protected]> Reviewed-by: silverwind <[email protected]>
This commit is contained in:
@@ -8,7 +8,7 @@
|
||||
|
||||
export type LocaleId = 'en-us' | 'zh-cn' | 'zh-tw';
|
||||
|
||||
export type ProductId = 'docs' | 'api' | 'runner' | 'enterprise';
|
||||
export type ProductId = 'docs' | 'api' | 'runner' | 'cli' | 'enterprise';
|
||||
|
||||
/** Values substituted for `@name@` placeholders in the markdown sources. */
|
||||
export interface VersionVariables {
|
||||
@@ -246,6 +246,40 @@ const runnerProduct: ProductDef = {
|
||||
],
|
||||
};
|
||||
|
||||
/**
|
||||
* gt, the Gitea CLI: laid out like the runner. Until the first series is listed
|
||||
* here the develop docs are served at the product root, without the unreleased
|
||||
* banner, since there is no release to point to. Listing a series moves them to
|
||||
* `/cli/develop/`.
|
||||
*/
|
||||
const cliSeries: { id: string; latestRelease: string }[] = [];
|
||||
|
||||
const cliProduct: ProductDef = {
|
||||
id: 'cli',
|
||||
label: 'CLI',
|
||||
base: 'cli',
|
||||
locales: ['en-us'],
|
||||
versions: [
|
||||
{
|
||||
id: 'develop',
|
||||
label: 'develop',
|
||||
sources: { 'en-us': 'cli-docs' },
|
||||
...(cliSeries.length > 0
|
||||
? { path: 'develop', banner: 'unreleased' as const }
|
||||
: { path: '', latest: true }),
|
||||
},
|
||||
...cliSeries.map(
|
||||
({ id, latestRelease }, index): VersionDef => ({
|
||||
id,
|
||||
label: latestRelease,
|
||||
path: index === 0 ? '' : id,
|
||||
latest: index === 0,
|
||||
sources: { 'en-us': `cli-docs_versioned_docs/version-${id}` },
|
||||
}),
|
||||
),
|
||||
],
|
||||
};
|
||||
|
||||
/** API reference, rendered from the swagger documents by starlight-openapi. */
|
||||
const apiProduct: ProductDef = {
|
||||
id: 'api',
|
||||
@@ -301,7 +335,13 @@ const enterpriseProduct: ProductDef = {
|
||||
externalBaseUrl: 'https://docs.gitea.com/enterprise',
|
||||
};
|
||||
|
||||
export const products: ProductDef[] = [docsProduct, apiProduct, runnerProduct, enterpriseProduct];
|
||||
export const products: ProductDef[] = [
|
||||
docsProduct,
|
||||
apiProduct,
|
||||
runnerProduct,
|
||||
cliProduct,
|
||||
enterpriseProduct,
|
||||
];
|
||||
|
||||
export function getProduct(id: ProductId): ProductDef {
|
||||
const product = products.find((candidate) => candidate.id === id);
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
/**
|
||||
* Builds one sidebar per (product, version, language) out of the loaded pages,
|
||||
* deriving it from `_category_.json` and from the
|
||||
* handwritten sidebar files of the runner docs.
|
||||
* handwritten sidebar files of the runner and the cli docs.
|
||||
*/
|
||||
|
||||
import { defaultLocale } from './products';
|
||||
@@ -44,7 +44,7 @@ export interface SidebarGroup {
|
||||
|
||||
export type SidebarEntry = SidebarLink | SidebarGroup;
|
||||
|
||||
/** A hand written sidebar file, as used by the runner docs. */
|
||||
/** A hand written sidebar file, as used by the runner and the cli docs. */
|
||||
export type SidebarSourceItem =
|
||||
| string
|
||||
| { type: 'doc'; id: string; label?: string }
|
||||
@@ -148,7 +148,7 @@ function treeOf(pages: SidebarPage[]): Tree {
|
||||
return { build, label };
|
||||
}
|
||||
|
||||
/** Sidebar described by a hand written sidebar file, used by the runner docs. */
|
||||
/** Sidebar described by a hand written sidebar file, used by the runner and the cli docs. */
|
||||
function fromSidebarSource(
|
||||
items: SidebarSourceItem[],
|
||||
pages: SidebarPage[],
|
||||
|
||||
Reference in New Issue
Block a user