Skip to content

Commit d81de31

Browse files
devmnjdevmnj
committed
🎉 INT COMMIT:
0 parents  commit d81de31

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+20374
-0
lines changed

‎.eslintignore

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.DS_Store
2+
node_modules
3+
/build
4+
/.svelte-kit
5+
/package
6+
.env
7+
.env.*
8+
!.env.example
9+
10+
# Ignore files for PNPM, NPM and YARN
11+
pnpm-lock.yaml
12+
package-lock.json
13+
yarn.lock

‎.eslintrc.cjs

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
module.exports = {
2+
root: true,
3+
extends: ['eslint:recommended', 'prettier'],
4+
plugins: ['svelte3'],
5+
overrides: [{ files: ['*.svelte'], processor: 'svelte3/svelte3' }],
6+
parserOptions: {
7+
sourceType: 'module',
8+
ecmaVersion: 2020
9+
},
10+
env: {
11+
browser: true,
12+
es2017: true,
13+
node: true
14+
}
15+
};

‎.gitignore

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.DS_Store
2+
node_modules
3+
/build
4+
/.svelte-kit
5+
/package
6+
.env
7+
.env.*
8+
!.env.example

‎.npmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
engine-strict=true

‎.prettierignore

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.DS_Store
2+
node_modules
3+
/build
4+
/.svelte-kit
5+
/package
6+
.env
7+
.env.*
8+
!.env.example
9+
10+
# Ignore files for PNPM, NPM and YARN
11+
pnpm-lock.yaml
12+
package-lock.json
13+
yarn.lock

‎.prettierrc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"useTabs": true,
3+
"singleQuote": true,
4+
"trailingComma": "none",
5+
"printWidth": 100
6+
}

‎.vscode/settings.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"cSpell.words": [
3+
"colorblast"
4+
]
5+
}

‎README.md

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
<p align="center">
2+
<a href="" rel="noopener">
3+
<img src="https://i.imgur.com/AZ2iWek.png" alt="Project logo"></a>
4+
</p>
5+
<h3 align="center">Svelte Docs</h3>
6+
7+
<div align="center">
8+
9+
[![Hackathon](https://img.shields.io/badge/svelt-docs-docs.svg)](http://hackathon.url.com)
10+
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)
11+
12+
</div>
13+
14+
15+
<p align="center">Svelte Docs
16+
17+
> This is Svelte app template for generating documentation site using Markdown files.
18+
<br>
19+
</p>
20+
21+
## 📝 Table of Contents
22+
- [🚂 How this app works ? <a name = "how"></a>](#-how-this-app-works---)
23+
- [🖊️ Filename and url <a name="url"/>](#️-filename-and--url-a-nameurl)
24+
- [⛽ .env <a name="env"/>](#-env-a-nameenv)
25+
- [💡Develop <a name = "develop"></a>](#develop-)
26+
- [⛏️ Built With <a name = "tech_stack"></a>](#️-built-with-)
27+
- [🔷 Additional Guide](#-additional-guide)
28+
- [✍️ Authors <a name = "authors"></a>](#️-authors-)
29+
- [🏖️ How to deploy the app <a name="deploy"></a>](#️-how-to-deploy-the-app-)
30+
- [🎉 Acknowledgments <a name = "acknowledgments"></a>](#-acknowledgments-)
31+
32+
# 🚂 How this app works ? <a name = "how"></a>
33+
There is `docs` folder under the `src/routes/`, this is where need to place the .md / .svx files, which is treated as page in your app.
34+
35+
## 🖊️ Filename and url <a name="url"/>
36+
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.
37+
## ⛽ .env <a name="env"/>
38+
Please update .env with your settings.
39+
# 💡Develop <a name = "develop"></a>
40+
41+
For developing and make changes to this project, you need to install [Nodejs](https://nodejs.org/en/), [Svelt](https://svelte.dev/) JavaScript Framework.
42+
43+
Fork the repository or download the project to a local machine. Then `run yarn install` for dependency setup ( from the root directory).
44+
45+
Now let's start the development server and modify:
46+
47+
```bash
48+
npm run dev
49+
# or start the server and open the app in a new browser tab
50+
npm run dev -- --open
51+
```
52+
# ⛏️ Built With <a name = "tech_stack"></a>
53+
54+
- [Svelte](https://svelte.dev/) - Web Framework
55+
- [NodeJs](https://nodejs.org/en/) - Server Environment
56+
- [MDSVEX](https://mdsvex.com/) - Markdown Preprocessor for Svelte
57+
- [Tailwind CSS](https://tailwindcss.com/) - CSS Framework
58+
59+
# 🔷 Additional Guide
60+
61+
[Learn Svelte Programming - from scratch ](http://javascriptsu.wordpress.com/tag/svelte)
62+
63+
# ✍️ Authors <a name = "authors"></a>
64+
65+
- [@devmnj](https://github.com/devmnj) - Idea & Initial work
66+
67+
# 🏖️ How to deploy the app <a name="deploy"></a>
68+
# 🎉 Acknowledgments <a name = "acknowledgments"></a>
69+
70+
- The work is impossible without MDSVEX and Svelte.
71+

‎jsconfig.json

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"extends": "./.svelte-kit/tsconfig.json",
3+
"compilerOptions": {
4+
"allowJs": true,
5+
"checkJs": true,
6+
"esModuleInterop": true,
7+
"forceConsistentCasingInFileNames": true,
8+
"resolveJsonModule": true,
9+
"skipLibCheck": true,
10+
"sourceMap": true,
11+
"strict": true
12+
}
13+
}

‎mdsvex.config.js

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import { defineMDSveXConfig as defineConfig } from 'mdsvex';
2+
3+
const config = defineConfig({
4+
extensions: ['.svelte.md','.svelte', '.md', '.svx'],
5+
6+
smartypants: {
7+
dashes: 'oldschool'
8+
},
9+
10+
remarkPlugins: [],
11+
rehypePlugins: []
12+
});
13+
14+
export default config;

0 commit comments

Comments
 (0)