ti.sil/sourcebot
1
0
Fork 0
mirror of https://github.com/sourcebot-dev/sourcebot.git synced 2025-12-12 12:25:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
sourcebot/docs
History
bkellam 2b17fd6702 dummy change
2025-03-21 11:28:25 -07:00
..
docs dummy change 2025-03-21 11:28:25 -07:00
images Add docs to this repo 2025-03-21 11:26:54 -07:00
logo Add docs to this repo 2025-03-21 11:26:54 -07:00
self-hosting Add docs to this repo 2025-03-21 11:26:54 -07:00
snippets Add docs to this repo 2025-03-21 11:26:54 -07:00
.editorconfig Add docs to this repo 2025-03-21 11:26:54 -07:00
development.mdx Add docs to this repo 2025-03-21 11:26:54 -07:00
docs.json Add docs to this repo 2025-03-21 11:26:54 -07:00
fav.svg Add docs to this repo 2025-03-21 11:26:54 -07:00
introduction.mdx Add docs to this repo 2025-03-21 11:26:54 -07:00
quickstart.mdx Add docs to this repo 2025-03-21 11:26:54 -07:00
README.md Add docs to this repo 2025-03-21 11:26:54 -07:00

README.md

Mintlify Starter Kit

Click on Use this template to copy the Mintlify starter kit. The starter kit contains examples including

  • Guide pages
  • Navigation
  • Customizations
  • API Reference pages
  • Use of popular components

Development

Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command

npm i -g mintlify

Run the following command at the root of your documentation (where docs.json is)

mintlify dev

Publishing Changes

Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.

Troubleshooting

  • Mintlify dev isn't running - Run mintlify install it'll re-install dependencies.
  • Page loads as a 404 - Make sure you are running in a folder with docs.json