{"id":22889606,"url":"https://github.com/dillingham/notable","last_synced_at":"2025-05-07T14:46:17.279Z","repository":{"id":64171649,"uuid":"293584597","full_name":"dillingham/notable","owner":"dillingham","description":null,"archived":false,"fork":false,"pushed_at":"2022-12-04T03:10:03.000Z","size":72,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-31T11:11:12.296Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","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/dillingham.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":"2020-09-07T16:57:46.000Z","updated_at":"2023-02-18T07:10:20.000Z","dependencies_parsed_at":"2023-01-15T02:15:15.646Z","dependency_job_id":null,"html_url":"https://github.com/dillingham/notable","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dillingham%2Fnotable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dillingham%2Fnotable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dillingham%2Fnotable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dillingham%2Fnotable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dillingham","download_url":"https://codeload.github.com/dillingham/notable/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252898392,"owners_count":21821609,"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":[],"created_at":"2024-12-13T21:56:21.392Z","updated_at":"2025-05-07T14:46:17.253Z","avatar_url":"https://github.com/dillingham.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Notable\n\nA simple documentation package for Laravel.\n\n```\nphp artisan notable:install\n```\n\n- adds a `docs` folder in your project's root for markdown\n\n- adds a `docs` folder in  resources/views for the page layout\n\n- adds the following route to the top of routes/web.php\n\n\n```\nRoute::markdown('docs', base_path('docs'));\n```\n\n1st parameter is the endpoint to make the root\n2nd parameter is a path to a markdown folder\n\nA file with the following path in a project:\n\n```\ndocs/getting-started/installation.md\n```\nwill appear like this in the browser\n```\ndocs/getting-started/installation\n```\n\nNote: `docs` in the url is from Route definition\nIt isn't the folder's name. It can be changed.\n\n### TODO:\n\n- [ ] Cache html rendered markdown.. if modified time \u003e last cache, render\n- [ ] Add folder and file number ordering 1-getting-started -\u003e 1-installation\n- [ ] Add route helpers for settings (see below)\n- [ ] Add \"On this page\" section links\n- [ ] Add repository config for \"edit page\"\n\n\n```php\nRoute::markdown()\n    -\u003edirectory(base_path('docs'))\n    -\u003eprefix('documentation')\n    -\u003eview('docs.show')\n    -\u003esections(config('docs.sections'))\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdillingham%2Fnotable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdillingham%2Fnotable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdillingham%2Fnotable/lists"}