animethemes / animethemes-api-docs Goto Github PK

We currently leverage Vuepress 1.X to generate the site. This was chosen because some Laravel projects make use of Vuepress for their documentation. Vuepress-Next and Vitepress are in alpha/beta states. We might want to shop frameworks and look for an ecosystem that isn't splintering.

If possible, I'd like to stick to an SSG framework derived from markdown source documents to minimize the barrier to entry, but if someone is interested, they can propose and lead an effort for something more sophisticated.

Some solutions to research:

• Docsify
• Docusaurus
• Docz (Gatsby theme)
• GitBook
• Jekyll
• MkDocs (Material comes recommended)
• Nextra (Next.js)
• Slate
• Vitepress
• Vuepress 2.X (beta)

Vitepress allows for a search component to be configured. This would be useful in letting the user navigate directly to a page without needing to drill down through the nav component.

At the moment, the native search component requires either paying for Algolia or getting an OSS application accepted by them. Based on our current funding, I don't believe a paid plan from Algolia is wise. I am also skeptical that an OSS application would be accepted for AnimeThemes. Additionally, this isn't an ideal solution for offline search.

The first stable release milestone for Vitepress includes offline search support, but this can only currently be accomplished with community plugins:

• vitepress-plugin-search
• vitepress-plugin-simple-search

We should find a solution that supports reasonable offline and live searching for the search component.

The new namespaced index pages would benefit from giving a visual overview of model relations.

IMO a set of diagrams produced from a service like draw.io or lucidchart would be sufficient.

• Admin
• Billing
• Document
• List
• Wiki

Vitepress provides build hooks that we can leverage for sitemap generation.

Simple example script from the Vitepress community: vuejs/vitepress#520 (comment)