README.md

Svelte Docs

Svelte Docs

This is Svelte app template for generating documentation site using Markdown files. Have a look at the demo

📝 Table of Contents

• 📝 Table of Contents
• 🚂 How this app works ?
  • 🖊️ Filename and url
  • ⛽ .env
• Experimenting
• ⛏️ Built With
• 🔷 Additional Guide
• ✍️ Authors
• 🏖️ How to deploy the app
• 🎉 Acknowledgments

🚂 How this app works ?

There is docs folder under the src/routes/, this is where need to place the .svx files (markdown), which is treated as page in the app.

Each of the markdown document should have the following fields

---
section: Intro
under: root 
---

🖊️ Filename and url

The file name should not include white space, files name used for url.Since url doesn't allow spaces, we have to use something like, installation-guide where whitespace required.

⛽ .env

Please update .env with your settings.

Experimenting

For developing and make changes to this project, you need to install Nodejs, Svelt JavaScript Framework.

Fork the repository or download the project to a local machine. Then run yarn install for dependency setup ( from the root directory).

This application uses a .env file which store the site configuaration, this repo has .env.production which is used to configure the settings in production mode. You have to create a .env file for local development with same content.

Now let's start the development server and modify:

npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open

⛏️ Built With

• Svelte - Web Framework
• NodeJs - Server Environment
• MDSVEX - Markdown Preprocessor for Svelte
• Tailwind CSS - CSS Framework

🔷 Additional Guide

Learn Svelte Programming - from scratch

✍️ Authors

• @devmnj - Idea & Initial work

🏖️ How to deploy the app

For deployment , try Vercel, it is so easy to deploy a JAM stack app with Vercel. In this application uses a .env file which store the site configurations, which is not exported to git hub, instead I have .env.production which is used to configure the settings @ production.

I also removed .env.production file from the gitignore , so that they are uploaded to my repository.

🎉 Acknowledgments

• The work is impossible without MDSVEX and Svelte.