Skip to main content

Tidy Shelves Project Docusaurus Steps

  • Clone to Visual studio, the AC Docs project from the TFS organization - Documentation-org from pm.aspireclan.com
  • Show a local path to store the AC Docs source code
  • Refer the link https://docusaurus.io/docs/installation or https://docs.aspireclan.com/docs/intro
  • Download and install latest (LTS) version of Node.js, if not installed already. Download the Prebuilt Installer
  • Last installed version is 22.14.0
  • run npm install
  • run npm audit fix (multiple times to fix all vulnerabilities)
  • run npm install 'clipboard-copy'
  • run npm run start
  • in docusaurus.config.ts add a dropdown menu item with label: 'Tidy Shelves'
,{ 
  label: 'Tidy Shelves', // The text for the first item in the dropdown
  sidebarId: 'tsSidebar',
  to: 'docs/category/tidy-shelves', // The target URL for the first item
}
  • in sidebars.ts add the sidebar for Tidy Shelves
tsSidebar: [{ type: 'autogenerated', dirName: 'Applications/tidy-shelves' }],
  • under docs/applications create a new folder structure tidy-shelves/pages
[IMPORTANT] : The application folder name must be "tidy-shelves". Any other names given to the folder will not work. "-" is used to denote the space between tidy and shelves. Auto generated sidebards will alway create breadcrumbs and Labels based on folder names and category.json
  • under "pages" folder create a new file with the content as below:
_category_.json
{
    "label": "Tidy Shelves",
    "position": 1,
    "link": {
      "type": "generated-index"
    }
}
  • Under "pages" folder create a new folder "ts-projectsetupsoe"
  • under "ts-projectsetupsoe" folder create a new file with the content as below:
_category_.json
{
    "label": "TS Project Setup SOE",
    "position": 1,
    "link": {
      "type": "generated-index"
    }
}
  • Create a new .mdx file "ts-docusaurussteps.mdx"
  • Capture all documentation related steps here...
  • For creating furhter menus, submenus and pages, follow steps above from Under "pages" folder create a new folder "ts-projectsetupsoe"