{"id":15002366,"url":"https://github.com/nedpals/sulatcms","last_synced_at":"2025-10-03T13:31:06.805Z","repository":{"id":57374280,"uuid":"122823365","full_name":"nedpals/sulatcms","owner":"nedpals","description":"Super simple platform-agnostic headless CMS","archived":true,"fork":false,"pushed_at":"2020-09-04T01:11:35.000Z","size":834,"stargazers_count":3,"open_issues_count":3,"forks_count":0,"subscribers_count":3,"default_branch":"next","last_synced_at":"2024-09-25T18:49:48.149Z","etag":null,"topics":["cms","git","headless-cms","jamstack","javascript","static"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nedpals.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-02-25T09:49:23.000Z","updated_at":"2023-05-12T16:50:17.000Z","dependencies_parsed_at":"2022-09-17T16:00:30.850Z","dependency_job_id":null,"html_url":"https://github.com/nedpals/sulatcms","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/nedpals%2Fsulatcms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nedpals%2Fsulatcms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nedpals%2Fsulatcms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nedpals%2Fsulatcms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nedpals","download_url":"https://codeload.github.com/nedpals/sulatcms/tar.gz/refs/heads/next","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219876396,"owners_count":16554752,"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":["cms","git","headless-cms","jamstack","javascript","static"],"created_at":"2024-09-24T18:49:51.586Z","updated_at":"2025-10-03T13:31:06.439Z","avatar_url":"https://github.com/nedpals.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e **ATTENTION**: This is currently in development. Please wait for the stable release.\n\u003e You are looking for the next version of SulatCMS currently developed right now.\n\n# SulatCMS [![Maintainability](https://api.codeclimate.com/v1/badges/c2985411330f1b918966/maintainability)](https://codeclimate.com/github/nedpals/sulatcms/maintainability)\nSimple plugin-driven Headless CMS for JAMstack sites.\n\n## Features\n1. **Platform-agnostic** - Edit your markdown posts from your local filesystem, git, WordPress, and etc.\n2. **Plugin-driven** - From content manipulation to publishing your content, they are all handled by plugins.\n3. **Barebones** - A Sulat installation with no plugins only weighs about `60kb` compared to previous version.\n4. **Powered by [Mithril](https://mithril.js.org)** - A tiny, complete out-of-the box Javascript library makes Sulat slim and fast.\n\n## Install\nTo start, install Sulat via NPM/Yarn or\n\n```bash\nyarn add https://github.com/nedpals/sulatcms#next\n```\nor you can embed it directly\n\n```html\n\u003c!-- Place the javascript file before the \u003cbody\u003e closing tag --\u003e\n\u003cscript type=\"text/javascript\" src=\"https://cdn.jsdelivr.net/gh/nedpals/sulatcms@next/dist/sulat.js\"\u003e\n```\n\n### Usage\n\nTo get started, initialize first the CMS by invoking the `initialize` function. If you are setting up in the browser without any build tools, you can access it through `window.sulat`.\n\n```javascript\nsulatcms.initialize({\n    el: document.getElementById(\"sulat\"),\n    auth: \"netlify\", // if you are using authentication, you need to set the default provider.\n    plugins: [\n        //... plugins goes here.\n        netlifyIdentityPlugin(),\n        gitlabPlugin()\n    ]\n})\n```\nOnce you set up and install all the plugins, you're good to go!\n\n## Plugins\nWhat makes SulatCMS unique is the first-class support of plugins. Plugins what makes the CMS functionable from content management to authentication.\n\n### Creating a plugin\nSulatCMS plugins are just regular functions returning a single plugin object. The plugin object contains metadata for the plugin (name and etc.) as well as it's event functions both for the CMS and authentication management.\n\n```javascript\nfunction myFirstPlugin(options) {\n    return {\n        name: \"my-first-plugin\",\n        events: {\n            onInit() {\n                console.log(\"Hello \" + options.name);\n            }\n        }\n    };\n}\n```\n\n### Using the plugin\nYou can simply add the plugin to the CMS's config:\n```javascript\ninitialize({\n    // ...\n    plugins: [myFirstPlugin({\n        name: \"Bob\"\n    })]\n    //...\n})\n```\nAs soon as the as the CMS is loaded, the plugins are automatically loaded. In this case, our plugin executes after the CMS has been fully loaded.\n\n## Development Notes\n- Plugin system now implemented. I'm gonna think first what set of APIs will be implemented.\n\n## Pre-launch plans\n- [x] ~~Make Github and Gitlab as default platforms~~\n   - **Note:** Login only works on Netlify sites. Still working on making it usable for non-Netlify sites.\n- [x] ~~Implement few API's for plugins~\n- [ ] Cleanup the UI\n- [x] Target file size should be atleast between *100-300kb*\n\n## Contribute\nTo start:\n\n```bash\n$ npm install\n```\n\n\nTo develop:\n\n```bash\n$ npm run dev\n```\n\nTo build for production:\n\n```bash\n$ npm run build\n```\n\n---\n\n\u0026copy; 2018 [nedpals](https://github.com/nedpals).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnedpals%2Fsulatcms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnedpals%2Fsulatcms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnedpals%2Fsulatcms/lists"}