This directory contains Typesense's documentation site.
It uses vuepress as a Static Site Generator.
On deployment, the dist folder generated is copied to https://typesense.org/docs.
-
Navigate to
typesense-website/docs-site/ -
Run
yarn -
Run
yarn dev -
Visit the link shown
As you write content in the content folder, the page should live reload.
Place images in content/.vuepress/public/images. Prefer using SVGs.
Reference images in markdown files like this:
where typesense-dynamodb.svg is located at ./content/.vuepress/public/images/typesense-dynamodb.svg
These variables can be used in markdown files as {{ variableName }} or in Vue components.
| Variable | Definition |
|---|---|
| $page.typesenseVersion | The current Typesense version that the user is looking at docs for. Will be null for non-versioned top level files. |
| $site.themeConfig.typesenseVersions | List of all Typesense versions |
Note: These variables don't work in auto-generated anchor tags and page titles.
To partially fix the issue with page titles, we have a workaround in plugins/typesense-enhancements to manually look for {{ $page.typesenseVersion }} in page titles and replace them.
- Add version number to
../typesenseVersions.js - Clone the latest version directory and make edits to it.
- Update sitemap priority for old version:
find content/<old.version.number> -type f -name "*.md" -exec gsed -i 's/ priority: 0.7/ priority: 0.3/' {} +
- Deploy both main site and docs site (since the main site has references to the latest version)
- We override a few components from the default theme, by placing them in
content/.vuepress/theme/components/ - Custom components go in
content/.vuepress/components/and can be referenced in any markdown files - Vuepress configuration goes in
content/.vuepress/config.js
yarn deploy