{"id":15177353,"url":"https://github.com/writteli/writteli","last_synced_at":"2025-10-01T16:31:12.780Z","repository":{"id":44116848,"uuid":"174828673","full_name":"writteli/writteli","owner":"writteli","description":"Your next favorite static site generator","archived":true,"fork":false,"pushed_at":"2022-12-06T17:13:03.000Z","size":320,"stargazers_count":1,"open_issues_count":12,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-09-28T14:21:27.783Z","etag":null,"topics":["blogging","blogging-engine","markdown","pug","pugjs","sass","static-site","static-site-generator","writing"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/writteli.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-10T13:39:43.000Z","updated_at":"2024-02-07T19:19:02.000Z","dependencies_parsed_at":"2023-01-23T10:50:48.273Z","dependency_job_id":null,"html_url":"https://github.com/writteli/writteli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/writteli%2Fwritteli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/writteli%2Fwritteli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/writteli%2Fwritteli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/writteli%2Fwritteli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/writteli","download_url":"https://codeload.github.com/writteli/writteli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234882636,"owners_count":18901301,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blogging","blogging-engine","markdown","pug","pugjs","sass","static-site","static-site-generator","writing"],"created_at":"2024-09-27T14:21:27.291Z","updated_at":"2025-10-01T16:31:12.422Z","avatar_url":"https://github.com/writteli.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Frequently Asked Questions\r\n\r\n1. What is a writteli?\r\n\r\nWritteli is a static site generator, build with [KISS](https://en.wikipedia.org/wiki/KISS_principle) principle in heart.\r\n\r\n2. Another static site generator? Why?\r\n\r\nBecause 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.\r\n\r\n3. What technologies writteli use?\r\n\r\nTemplate 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.\r\n\r\n4. Why pug and not _____?\r\n\r\nBecause of keeping it simple. Besides that, pug is very easy to learn, and still pretty popular.\r\n\r\n5. How to use it?\r\n\r\nScroll down and read.\r\n\r\n6. Will be there CLI?\r\n\r\nYes.\r\n\r\n7. Will be there a GUI version for non-technical people?\r\n\r\nYes.\r\n\r\n8. Will be there a mobile app?\r\n\r\nMaybe, not yet decided.\r\n\r\n9. What's the license?\r\n\r\nIt is and will always be an open source under MIT license. Keeping the `Built with writteli \u003c3` tagline in the footer will be highly appreciated.\r\n\r\n10. Is it writteli, Writte.li, or Writteli ?\r\n\r\nIt's **writteli** (*/ˈrʌɪtəli/*). The [writte.li](https://writte.li) is the domain name of the whole project.\r\n\r\n# Getting started\r\n\r\nFirst, fork this repo to your git account, then clone it to your local machine.\r\n\r\nEnter the folder of the project and run npm install command:\r\n\r\n```\r\nnpm i\r\n```\r\n\r\nIt will install all necessary dependencies.\r\n\r\nRename `config--example.js` file to `config.js` (project root folder) or make a file copy with that name (just in case).\r\n\r\n# Troubleshooting\r\n\r\nOn 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:\r\n\r\n```\r\nnpm i -g node-sass\r\n```\r\n\r\n# First run\r\n\r\nIf you want to see live changes of your website, you can run a local server using command:\r\n\r\n```\r\nnpm run server\r\n```\r\n\r\nIt will start local server at `localhost:3000`.\r\n\r\nIf you want just to compile final version of your website, you can use `compile` method:\r\n\r\n```\r\nnpm run compile\r\n```\r\n\r\nCompiled website contents will be saved at `/output` folder.\r\n\r\n# Author\r\n\r\nAuthor of this tool is lukasz kups. You can reach me via [email](mailto:hi@lukaszkups.net) or [twitter](https://twitter.com/lukaszkups).\r\n\r\n# License\r\n\r\nThis tool is devleoped and maintained under MIT License.\r\n\r\n# Available themes\r\n\r\n- [brutalist](https://github.com/lukaszkups/writteli/tree/master/theme/brutalist)\r\n\r\n# Showcase\r\n\r\nWebsites that are built with writteli (feel free to commit yours!):\r\n\r\n- https://writte.li\r\n- https://lukaszkups.net\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwritteli%2Fwritteli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwritteli%2Fwritteli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwritteli%2Fwritteli/lists"}