{"id":23446476,"url":"https://github.com/segundofdez/docstyle","last_synced_at":"2026-04-11T21:39:07.522Z","repository":{"id":141450181,"uuid":"65506784","full_name":"segundofdez/docstyle","owner":"segundofdez","description":"Make simple style guides or documentations using markdown","archived":false,"fork":false,"pushed_at":"2016-08-11T23:34:14.000Z","size":235,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-10T00:50:03.335Z","etag":null,"topics":["documentation","markdown"],"latest_commit_sha":null,"homepage":null,"language":"CSS","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/segundofdez.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","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":"2016-08-11T22:55:49.000Z","updated_at":"2023-03-05T03:50:56.000Z","dependencies_parsed_at":null,"dependency_job_id":"fdb8e86c-bea6-4adf-b032-6bd9e15e67c0","html_url":"https://github.com/segundofdez/docstyle","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/segundofdez/docstyle","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/segundofdez%2Fdocstyle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/segundofdez%2Fdocstyle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/segundofdez%2Fdocstyle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/segundofdez%2Fdocstyle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/segundofdez","download_url":"https://codeload.github.com/segundofdez/docstyle/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/segundofdez%2Fdocstyle/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263457203,"owners_count":23469295,"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":["documentation","markdown"],"created_at":"2024-12-23T20:35:04.482Z","updated_at":"2026-04-11T21:39:02.495Z","avatar_url":"https://github.com/segundofdez.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"#docstyle\nWelcome to docstyle basic template. The purpose of this project is to offer a simple layout to make style guides or simple documentations using markdown files.\n\n![Docstyle logo](https://github.com/segundofdez/docstyle/blob/4e2f205daa311d718fa5326d3d7b3b5962c7df17/public/img/logo.png)\n\n## Install\n1. Download de latest version of docstyle\n2. composer install\n3. bower install\n4. npm install\n\n## Configure\nYou can configure some parameters like sitename, lang, description... in **public/index.php**. Also you can configure your .md files routes.\n\n```php\n$data = [\n\n    'home' =\u003e $home,\n    'lang' =\u003e 'en',\n    'title' =\u003e 'docstyle',\n    'description' =\u003e 'Basic template for styleguides or documentations using markdown',\n    'version' =\u003e '1.0.0',\n    'getting_started' =\u003e $parse-\u003etext( file_get_contents( $data_dir . '00_getting_started.md') ),\n\n];\n```\n\nAdd the routes in your template **source/templates**\n```html\n[...]\n\u003cnav class=\"nav\"\u003e\n    \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\u003c/li\u003e\n    \u003c/ul\u003e\n\u003c/nav\u003e\n[...]\n\u003cdiv id=\"getting-started\"\u003e\n    \u003c?php echo $getting_started; ?\u003e\n\u003c/div\u003e\n[...]\n```\n## Start\nAdd your markdow files to **source/data**.\nIf you need a diferent skin, you can modify the styles in **source/styles**.\n\n## Gulp\n\nStart a php server, browser-sync, watch changes on .less, .php, .md and .js:\n```bash\ngulp connect\n```\n\nCompile, minified and autoprefix styles to css:\n```bash\ngulp less\n```\n\nMinimize js:\n```bash\ngulp js\n```\n\nGenerate static html from php files:\n```bash\ngulp static\n```\n\n## Contributing\n\nPlease see [CONTRIBUTING](https://github.com/segundofdez/docstyle/blob/master/CONTRIBUTING.md) for details.\n\n\n## Creators\n\n**Segundo Fdez**\n\n- \u003chttp://segundofdez.com\u003e\n- \u003chttps://twitter.com/segundo_fdez\u003e\n\n\n**Contributors**\n- \u003chttps://github.com/segundofdez/docstyle/graphs/contributors\u003e\n\n\n## License\nCopyright (c) 2016 Segundo Fdez (http://segundofdez.com) Code released under the [the MIT license](https://github.com/segundofdez/docstyle/blob/master/LICENSE.md)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsegundofdez%2Fdocstyle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsegundofdez%2Fdocstyle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsegundofdez%2Fdocstyle/lists"}