https://github.com/assistantapps/documentation
📖 Documentation website
https://github.com/assistantapps/documentation
Last synced: 5 months ago
JSON representation
📖 Documentation website
- Host: GitHub
- URL: https://github.com/assistantapps/documentation
- Owner: AssistantApps
- Created: 2021-12-05T15:54:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-12T18:27:57.000Z (about 3 years ago)
- Last Synced: 2024-12-26T11:07:30.909Z (over 1 year ago)
- Language: SCSS
- Homepage: https://docs.assistantapps.com
- Size: 988 KB
- Stars: 3
- Watchers: 1
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: docs/README.md
Awesome Lists containing this project
README
# Welcome to the Documentation repo! 🎉 👨💻
Editing the files in the `docs` folder will modify the pages on the [live site][docWebsite]. Feel free to create [Issues][docsIssues] and/or [Pull Requests][docsPullRequests] for changes you think will make the website better!
## Running it locally
### 1. Pull the source code
_Run this in your terminal or CMD_
```
git clone https://github.com/AssistantApps/Documentation.git
```
Then change directory to the correct folder
_Run this in your terminal or CMD_
```
cd Documentation
```
### 2. Install dependencies
_Run this in your terminal or CMD_
```
npm run dev:install
```
### 3. Run it
_Run this in your terminal or CMD_
```
npm run dev
```
### 4. View it
Open your browser (Chrome, Firefox, etc) to `localhost:3000`
---
## Please Note
If you want make any `css` changes, please make them in the `scss` folder, in the appropriate file. The `css` files are generated from the `scss` files.
You can test this by running `npm run styles`. This command will compile the `scss` files into the `css` files and then minify those `css` files.
[docWebsite]: https://docs.assistantapps.com?ref=AssistantAppsGithub
[homePage]: https://assistantapps.com?ref=AssistantAppsDocs
[docsIssues]: https://github.com/AssistantApps/Documentation/issues?ref=AssistantAppsDocs
[docsPullRequests]: https://github.com/AssistantApps/Documentation/pulls?ref=AssistantAppsDocs