Skip to content

Commit

Permalink
Added documentation using Docusaurus. Added GH actions.
Browse files Browse the repository at this point in the history
  • Loading branch information
visto9259 committed Apr 22, 2024
1 parent 1f22376 commit dc7b81b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
10 changes: 6 additions & 4 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

import {themes as prismThemes} from 'prism-react-renderer';

const ProjectName = 'LmcAdmin';

/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'LmcAdmin',
Expand All @@ -21,7 +23,7 @@ const config = {
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'lm-commons',
projectName: 'LmcAdmin',
projectName: ProjectName,
trailingSlash: false,

onBrokenLinks: 'throw',
Expand Down Expand Up @@ -75,7 +77,7 @@ themeConfig:
items: [
{
type: 'docSidebar',
sidebarId: 'tutorialSidebar',
sidebarId: 'documentationSidebar',
position: 'left',
label: 'Documentation',
},
Expand All @@ -86,7 +88,7 @@ themeConfig:
position: 'right',
},
{
href: 'https://github.com/lm-commons/lmcadmin',
href: `https://github.com/lm-commons/${ProjectName.toLowerCase()}`,
label: 'GitHub',
position: 'right',
},
Expand Down Expand Up @@ -122,7 +124,7 @@ themeConfig:
},
{
label: 'GitHub',
href: 'https://github.com/lm-commons/lmcmail',
href: `https://github.com/lm-commons/${ProjectName.toLowerCase()}`,
},
],
},
Expand Down
1 change: 0 additions & 1 deletion docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
documentationSidebar: [{type: 'autogenerated', dirName: '.'}],

// But you can create a sidebar manually
Expand Down

0 comments on commit dc7b81b

Please sign in to comment.