{"id":22994861,"url":"https://github.com/scriptype/writ-cms","last_synced_at":"2025-08-13T22:32:05.918Z","repository":{"id":63257438,"uuid":"563961240","full_name":"scriptype/writ-cms","owner":"scriptype","description":"The timeless SSG + CMS","archived":false,"fork":false,"pushed_at":"2025-04-16T00:23:14.000Z","size":3340,"stargazers_count":7,"open_issues_count":15,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-11T12:46:48.307Z","etag":null,"topics":["blog-engine","cms","content-management-system","ssg","static-site-generator"],"latest_commit_sha":null,"homepage":"https://enes.in/writ-cms","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scriptype.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["scriptype"]}},"created_at":"2022-11-09T17:41:35.000Z","updated_at":"2025-04-16T00:23:18.000Z","dependencies_parsed_at":"2023-11-20T01:44:03.582Z","dependency_job_id":"226c8775-f4c3-4021-9e98-54b403eab892","html_url":"https://github.com/scriptype/writ-cms","commit_stats":null,"previous_names":[],"tags_count":52,"template":false,"template_full_name":null,"purl":"pkg:github/scriptype/writ-cms","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptype%2Fwrit-cms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptype%2Fwrit-cms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptype%2Fwrit-cms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptype%2Fwrit-cms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scriptype","download_url":"https://codeload.github.com/scriptype/writ-cms/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptype%2Fwrit-cms/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270329187,"owners_count":24565772,"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","status":"online","status_checked_at":"2025-08-13T02:00:09.904Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["blog-engine","cms","content-management-system","ssg","static-site-generator"],"created_at":"2024-12-15T05:27:38.549Z","updated_at":"2025-08-13T22:32:05.877Z","avatar_url":"https://github.com/scriptype.png","language":"JavaScript","funding_links":["https://github.com/sponsors/scriptype"],"categories":[],"sub_categories":[],"readme":"# Writ-CMS\n\nThe timeless SSG + CMS, in the making.\n\n[![tests status badge](https://github.com/scriptype/writ-cms/actions/workflows/tests.yml/badge.svg)](https://github.com/scriptype/writ-cms/actions/workflows/tests.yml)\n[![Coverage Status](https://coveralls.io/repos/github/scriptype/writ-cms/badge.svg?fuckgithubcache=true)](https://coveralls.io/github/scriptype/writ-cms?branch=master)\n\n## Contents\n\n- [The idea](#the-idea)\n- [Example websites](#example-websites)\n- [Usage](#usage)\n- [Installation](#installation)\n- [Manual](#manual)\n- [Development](#development)\n\n## The idea\n\nWhen I'm writing a blog post, I want to deal with the least amount of software complexity.\n\n- I should be able to compose freeform html, rich text and markdown\n- I should be able to just use GUI from start to end\n- I should be able to organize categories, posts and pages using folders and text files\n- I should get automated index pages, pagination, sitemap, rss, search etc. without touching code\n- I should be able to easily customize it\n- I should be able to use it without remembering much\n- And, **everyone** also should be able to do all of those.\n\n## Example websites\n\n- [Writ](https://writ.enes.in) ([source](https://github.com/scriptype/writ))\n- [Reads Feed](https://enes.in/feed) ([source](https://github.com/scriptype/feed))\n- [Upstairs is boiling](https://upstairsisboiling.com) ([source](https://github.com/upstairsisboiling/upstairsisboiling.github.io))\n- [Uç! Uç!](https://ucuc.info) ([source](https://github.com/uc-uc/uc-uc.github.io))\n\n## Usage\n\n### 1) Name your site\n```sh\nmkdir \"All about trees\"\ncd \"All about trees\"\n```\n\n### 2) Create a post\n```sh\necho \"Pines are nice\" \u003e \"Hello world.txt\"\n```\n\n### 3) Preview and edit\n```sh\nwrit start\n```\n\n## Installation\n\n```sh\nnpm install -g scriptype/writ-cms\n```\n\n## Manual\n\n### Entry formats\n\n- Accepted text file extensions: .txt, .md, .markdown, .hbs, .html.\n\n### Categories\n\n1) Create a folder\n\nFolder name can be human readable and it will be used as the display name.\n\n### Posts\n\nCreate a new uncategorized post:\n1) Create a text file\n\nCreate a categorized post:\n1) Go to a category folder\n2) Create a text file inside the folder\n\n#### Foldered posts\n\nIf you need to refer/embed static assets, such as photos or demo iframes, within the post,\nthe easiest way is to have a folder for everything the post needs, including the post itself.\n\nCreate a foldered post:\n1) Create a folder\n2) Inside the folder, create a text file named \"post\". e.g post.md, post.txt\n\nHuman readable name of the folder will be the post title.\n\nA post file can look like this:\n\n```\nMy new post starts like this.\n\nAnd it ends like this.\n```\n\nYou can also add metadata like this in the beginning of a post file\n```\n---\ntype: text\ndate: 2023-01-05, 01:57\ntags: bananas, books\nmusiclist:\n - Your favorite artist - A song\n---\nMy new post starts like this.\n\nAnd it ends like this.\n```\n\n\"musiclist\" is displayed at the end of the post when it's rendered.\n\n### Subpages\n\n1) Create a folder named \"pages\"\n2) Create a text file inside the folder\n\n#### Foldered subpages\n\nJust like with foldered posts, foldered subpages is the easiest way to manage local assets.\n\n1) Create a folder inside the \"pages\" directory\n2) Inside the folder, create a text file named \"page\". e.g. page.txt, page.md, page.html\n\nYou can use a different folder for pages by adding this to `settings.json`:\n\n```\n\"pagesDirectory\": \"my-different-pages-folder\"\n```\n\n### Static assets\n\n1) Create a folder named \"assets\"\n2) Put any static assets into this folder\n\nYou can use a different folder for assets by adding this to `settings.json`:\n\n```\n\"assetsDirectory\": \"my-different-assets-folder\"\n```\n\n## Development\n\nClone writ-cms by running:\n\n```sh\ngit clone git@github.com:scriptype/writ-cms.git\n```\n\nThen set it up:\n\n```sh\ncd writ-cms\nnpm install\n\n# Sets up the git hooks\nnpm run hookup\n\n# Recommended for being able to quickly test things in any directory\nnpm i -g .\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscriptype%2Fwrit-cms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscriptype%2Fwrit-cms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscriptype%2Fwrit-cms/lists"}