/amido.github.io

📄 Amido Stacks open-source gateway to documentation, contribution, and raising issues

Primary LanguageJavaScript

Ensono Stacks Documentation Microsite

This repository contains the documentation for the Ensono Stacks platform. The live site is hosted at https://stacks.ensono.com.

This microsite is built using Docusaurus 2, a modern static website generator. You can view their documentation here.

Making changes

To make changes to the documentation, you will need to clone this repository and run the following commands to install the dependencies and start the development server.

npm install
npm run start

You can then edit the relevant markdown files in the docs folder and the site will automatically update. Once you are happy with your changes, you can commit them to a new branch and open a pull request.

Search functionality

The search functionality is using (Algolia DocSearch)[https://docusaurus.io/docs/search#using-algolia-docsearch] and the search component has been swizzle (It is in src/theme/SearchBar.js) because the version of docusaurus is using an old infrastructure so the search bar is not able to search anything in the documentation. It is using @docsearch/react which is the new infrastructure.

AppId, indexName and apiKey is needed to get the search functionality working, and this data is in the dashboard.

The dashboard for Algolia - an overview of the search (https://dashboard.algolia.com/) Configure the Algolia Crawler - https://crawler.algolia.com/

The login email is stacks@ensono.com

Ensono Stacks Repositories

These are the repositories that make up the Ensono Stacks platform:

Packages

Images