Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/writteli/writteli
Your next favorite static site generator
https://github.com/writteli/writteli
blogging blogging-engine markdown pug pugjs sass static-site static-site-generator writing
Last synced: 3 months ago
JSON representation
Your next favorite static site generator
- Host: GitHub
- URL: https://github.com/writteli/writteli
- Owner: writteli
- License: mit
- Archived: true
- Created: 2019-03-10T13:39:43.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T17:13:03.000Z (about 2 years ago)
- Last Synced: 2024-09-24T08:33:14.361Z (3 months ago)
- Topics: blogging, blogging-engine, markdown, pug, pugjs, sass, static-site, static-site-generator, writing
- Language: JavaScript
- Size: 313 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Frequently Asked Questions
1. What is a writteli?
Writteli is a static site generator, build with [KISS](https://en.wikipedia.org/wiki/KISS_principle) principle in heart.
2. Another static site generator? Why?
Because I can ;) To be honest, I was not satisfied with any available tools and while I was doing another redesign of my [website](https://lukaszkups.net) I decided to create an additional tooling as a side project.
3. What technologies writteli use?
Template language is [pug](https://pugjs.org), it supports ES6 JavaScript syntax as your website scripts and you can choose between traditional CSS, Sass or Sass with indented syntax.
4. Why pug and not _____?
Because of keeping it simple. Besides that, pug is very easy to learn, and still pretty popular.
5. How to use it?
Scroll down and read.
6. Will be there CLI?
Yes.
7. Will be there a GUI version for non-technical people?
Yes.
8. Will be there a mobile app?
Maybe, not yet decided.
9. What's the license?
It is and will always be an open source under MIT license. Keeping the `Built with writteli <3` tagline in the footer will be highly appreciated.
10. Is it writteli, Writte.li, or Writteli ?
It's **writteli** (*/ˈrʌɪtəli/*). The [writte.li](https://writte.li) is the domain name of the whole project.
# Getting started
First, fork this repo to your git account, then clone it to your local machine.
Enter the folder of the project and run npm install command:
```
npm i
```
It will install all necessary dependencies.
Rename `config--example.js` file to `config.js` (project root folder) or make a file copy with that name (just in case).
# Troubleshooting
On the first `npm i` run, you might have an error relates to `node-sass` library, which is a required dependency and should be installed globally:
```
npm i -g node-sass
```
# First run
If you want to see live changes of your website, you can run a local server using command:
```
npm run server
```
It will start local server at `localhost:3000`.
If you want just to compile final version of your website, you can use `compile` method:
```
npm run compile
```
Compiled website contents will be saved at `/output` folder.
# Author
Author of this tool is lukasz kups. You can reach me via [email](mailto:[email protected]) or [twitter](https://twitter.com/lukaszkups).
# License
This tool is devleoped and maintained under MIT License.
# Available themes
- [brutalist](https://github.com/lukaszkups/writteli/tree/master/theme/brutalist)
# Showcase
Websites that are built with writteli (feel free to commit yours!):
- https://writte.li
- https://lukaszkups.net