39 lines
1.0 KiB
Markdown
39 lines
1.0 KiB
Markdown
# The Shuffle Editor (https://shuffle.dev)
|
|
|
|
NOTE: npm commands overwrite the ./public directory.
|
|
|
|
## 1. Getting Started
|
|
|
|
Project's source files are placed in ./src/ directory.
|
|
|
|
* ./src/assets - default static files (eg. image placeholders). You should replace them with your own files.
|
|
* ./src/scss/ - Sass sources used to build Bootstrap theme. Variables used in Theme Customizer are located in custom-variables.scss file.
|
|
|
|
All your pages (templates) are stored in separated .pug or .html files (depends on your export preferences)
|
|
* ./src/pug/*.pug
|
|
* ./src/html/*.html
|
|
|
|
## 2. Installation
|
|
|
|
```
|
|
# Install dependencies
|
|
npm install
|
|
|
|
# Run dev server with live preview (Browsersync)
|
|
npm run watch
|
|
|
|
# Or make production build
|
|
npm run build
|
|
```
|
|
|
|
## 3. Contact
|
|
|
|
If you have found any bugs in the Tailwind Builder, have any questions,
|
|
comments or ideas for new features feel free to contact us:
|
|
|
|
support@shuffle.dev
|
|
|
|
## 4. Credits & Special thanks
|
|
|
|
We use placeholders from https://unsplash.com/
|