{"id":19112940,"url":"https://github.com/chipslays/readit","last_synced_at":"2026-06-22T19:02:54.932Z","repository":{"id":106411101,"uuid":"325045478","full_name":"chipslays/readit","owner":"chipslays","description":"✏ Ez way for deployment documentation pages.","archived":false,"fork":false,"pushed_at":"2021-01-12T18:52:50.000Z","size":139,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-22T11:41:13.116Z","etag":null,"topics":["docs-generator","documentation","documentation-generator","php"],"latest_commit_sha":null,"homepage":"","language":"HTML","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/chipslays.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-12-28T15:19:14.000Z","updated_at":"2021-01-12T18:52:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"8e0a9e95-80ec-435f-99e3-74ec31c22d4d","html_url":"https://github.com/chipslays/readit","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/chipslays/readit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chipslays%2Freadit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chipslays%2Freadit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chipslays%2Freadit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chipslays%2Freadit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chipslays","download_url":"https://codeload.github.com/chipslays/readit/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chipslays%2Freadit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34661709,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-22T02:00:06.391Z","response_time":106,"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":["docs-generator","documentation","documentation-generator","php"],"created_at":"2024-11-09T04:34:35.729Z","updated_at":"2026-06-22T19:02:54.913Z","avatar_url":"https://github.com/chipslays.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Read It!\n\nSimple way for deployment documentation pages.\n\n### Features\n\n* Markdown pages ([Github](https://github.com) flavored)\n* Easy customization\n* Darkmode\n* Themes\n\n### Installation\n\nThe installation is very hard and not every Jedi can handle it.\n\nFirst, let's copy the repository:\n\n```bash\ngit clone https://github.com/chipslays/readit.git\n```\n\nLet's go to the folder we just downloaded:\n\n```bash\ncd readit\n```\n\nInstall the required packages using [Composer](https://getcomposer.org/):\n\n```bash\ncomposer install\n```\n\nNow let's go to the public folder of the project:\n\n```bash\ncd public\n```\n\nAnd let's start the test server:\n\n```bash\nphp -S localhost:1337\n```\n\nYou can now open our test site [`localhost:1337`](http://localhost:1337) in a browser 🥳\n\nUff, it was really hard!\n\n... \n\nWhat? Nothing works..? Um... Then you better take the alternatives.\n\n### Dark theme\n![Dark](https://github.com/chipslays/readit/blob/master/.github/readit-dark.png)\n\n### Light theme\n![Light](https://github.com/chipslays/readit/blob/master/.github/readit-light.png)\n\n### Quick start\n\nPlace your markdown files in `/resources/docs` folder.\n\nFor example, there is one file called `getting-started.md`.\n\nNow, let's edit the file `/config/docs.php`, specify the desired text, route and the file itself.\n\n```php\nreturn [\n    [\n        'text' =\u003e 'Getting started',\n        'file' =\u003e 'getting-started.md',\n        'link' =\u003e '/',\n    ],\n];\n```\n##### Values\n* **`text`** - this is what we see in the sidebar.\n* **`file`** - this is the file from which the content for the page will be taken.\n* **`link`** - this is a route or external link.\n\n### Customization\n\nThe theme and links settings are in the file `/config/page.php`.\n\n```php\nreturn [\n    'theme' =\u003e [\n        'darkmode' =\u003e true,\n        'default' =\u003e 'dark',\n        'dark' =\u003e 'atom-one-dark',\n        'light' =\u003e 'atom-one-light',\n    ],\n    'navbar' =\u003e [\n        [\n            'type' =\u003e 'link',\n            'text' =\u003e 'Github',\n            'color' =\u003e 'blue',\n            'link' =\u003e '#',\n        ],\n        [\n            'type' =\u003e 'link',\n            'text' =\u003e '⭐ Become a sponsor',\n            'color' =\u003e 'purple',\n            'link' =\u003e '#',\n        ],\n    ],\n];\n```\n\n##### Theme values\n* **`theme.darkmode`** - set `false` for disable button. \n* **`theme.default`** - default theme for if site open first time. \n* **`theme.dark`** - dark theme. \n* **`theme.light`** - light theme. \n\n##### Navbar\n* **`type`** - type of element.\n* **`text`** - visible text.\n* **`color`** - color of element.\n* **`link`** - just link.\n\n### Themes\n\nAll themes files placed in `/resources/themes/`\n\nThis an example of `atom-one-dark.json` theme:\n\n```json\n{\n    \"name\": \"atom-one-dark\",\n    \"code_highlight_theme\": \"atom-one-dark\",\n    \"see_available_code_themes_here\": \"https://highlightjs.org/static/demo/\",\n    \"elements\": {\n        \"primary\": \"#E06C75\",\n        \"secondary\": \"#282c34\",\n        \"text\": \"#898f99\",\n        \"menu_item\": \"#898f99\",\n        \"menu_btn_text\": \"#ABB2BF\",\n        \"menu_btn_bg\": \"#1E2127\",\n        \"link\": \"#61afef\",\n        \"qoute\": \"#898f99\",\n        \"clipboard\": \"#fff\",\n        \"heading\": \"#ABB2BF\",\n        \"heading_hover\": \"#ABB2BF\",\n        \"background\": \"#23272e\",\n        \"border\": \"rgba(0, 0, 0, .225)\",\n        \"navbar\": \"rgb(35, 39, 46, 0.4)\"\n    },\n    \"colors\": {\n        \"black\": \"#1E2127\",\n        \"deep_black\": \"#1E2127\",\n        \"white\": \"#ABB2BF\",\n        \"deep_white\": \"#ABB2BF\",\n        \"gray\": \"#5C6370\",\n        \"deep_gray\": \"#5C6370\",\n        \"dark_gray\": \"#282c34\",\n        \"deep_dark_gray\": \"#282c34\",\n        \"red\": \"#E06C75\",\n        \"deep_red\": \"#E06C75\",\n        \"yellow\": \"#D19A66\",\n        \"deep_yellow\": \"#D19A66\",\n        \"green\": \"#98C379\",\n        \"deep_green\": \"#98C379\",\n        \"cyan\": \"#56B6C2\",\n        \"deep_cyan\": \"#56B6C2\",\n        \"blue\": \"#61afef\",\n        \"deep_blue\": \"#61afef\",\n        \"purple\": \"#c678dd\",\n        \"deep_purple\": \"#c678dd\"\n    }\n}\n```\n\n### TODO\n\n* Add versioning documentation\n* Code refactor\n* Fix known bugs\n\n---\n\n#### Crafted for yourself ❤️\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchipslays%2Freadit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchipslays%2Freadit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchipslays%2Freadit/lists"}