docs: setup docusaurus for documentation (#848)
* docs: setup docusaurus for documentation * docs: setup tailwind content for docusaurus * chore: ensure tailwindcss is installed so pages deploy works * docs: add cname to point to docs * ci: override format checking for pnpm-lock in gen-docs folder * docs(gen-docs): readme for docusaurus * chore(gen-docs): remove unnecessary image files * docs: remove installation instructions (moved to docs) * ci: rename docusaurus workflows to a more explicit name * style(gen-docs): custom color for links * docs: add more doc pages * style: gradient menu link bg, proper jellyseerr font & footer bg color * docs: fix proper link to relative pages * style: tab-items also now uses the proper jellyseerr colors * style: use prismTheme shadesOfPurple for codeblock/syntax highlighting * docs: fix broken links * docs: fix broken links * docs: fix broken anchors * chore(gen-docs): local search bar * style(gen-docs): tab colors * docs: reverse-proxy documentation * style(gen-docs): jellyseerr-like cards * docs: rename baremetal to build from source * docs: nixpkg version check component * docs: conditionally render override package derivation block and admonitions * docs: users section of the documentation
This commit is contained in:
31
gen-docs/sidebars.ts
Normal file
31
gen-docs/sidebars.ts
Normal file
@@ -0,0 +1,31 @@
|
||||
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
|
||||
|
||||
/**
|
||||
* Creating a sidebar enables you to:
|
||||
- create an ordered group of docs
|
||||
- render a sidebar for each doc of that group
|
||||
- provide next/previous navigation
|
||||
|
||||
The sidebars can be generated from the filesystem, or explicitly defined here.
|
||||
|
||||
Create as many sidebars as you want.
|
||||
*/
|
||||
const sidebars: SidebarsConfig = {
|
||||
// By default, Docusaurus generates a sidebar from the docs folder structure
|
||||
documentationSidebar: [{ type: 'autogenerated', dirName: '.' }],
|
||||
|
||||
// But you can create a sidebar manually
|
||||
/*
|
||||
tutorialSidebar: [
|
||||
'intro',
|
||||
'hello',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Tutorial',
|
||||
items: ['tutorial-basics/create-a-document'],
|
||||
},
|
||||
],
|
||||
*/
|
||||
};
|
||||
|
||||
export default sidebars;
|
||||
Reference in New Issue
Block a user