{"id":17069806,"url":"https://github.com/jlong/glyder","last_synced_at":"2026-04-30T22:35:47.270Z","repository":{"id":66244210,"uuid":"148059367","full_name":"jlong/glyder","owner":"jlong","description":"Flexible markdown styleguide generator with code previews","archived":false,"fork":false,"pushed_at":"2018-09-06T15:13:45.000Z","size":3037,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-28T02:41:03.606Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":false,"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/jlong.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2018-09-09T19:38:49.000Z","updated_at":"2022-09-06T09:45:26.000Z","dependencies_parsed_at":"2023-02-20T16:32:03.173Z","dependency_job_id":null,"html_url":"https://github.com/jlong/glyder","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jlong/glyder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlong%2Fglyder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlong%2Fglyder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlong%2Fglyder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlong%2Fglyder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jlong","download_url":"https://codeload.github.com/jlong/glyder/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlong%2Fglyder/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32479448,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"ssl_error","status_checked_at":"2026-04-30T13:12:06.837Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2024-10-14T11:27:54.096Z","updated_at":"2026-04-30T22:35:42.262Z","avatar_url":"https://github.com/jlong.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Glyder\n\nGlyder is a flexible markdown-based style guide generator with support for code previews.\n\nOnce installed, the `glyder` command can be used to transform any directory of Markdown files into a website.\n\n\n## Installation\n\nGlyder can be installed with plain ol' NPM:\n\n    npm install -g glyder\n\nIf you'd like to install it local to a project, use the `--save-dev` flag:\n\n    npm install --save-dev glyder\n\nPlease note that if you install glyder local to a project you will need to use the `npx` command with the glyder binary. For example:\n\n    npx glyder --help\n\n\n## Configuration\n\nConfiguration is stored in a `glyder.json` file stored in the root of your Glyder project.\n\nHere are the options, with default values shown:\n\n\n    {\n      \"input\": \"src\",                        // Directory where markdown and other source files are stored\n      \n      \"output\": \"build\",                     // Directory where build files are generated (HTML, etc.) \n\n      \"tmp\": \".tmp\",                         // Directory for temp files generated by glyder command\n\n      \"logo\": \"/glyder-logo.svg\",            // Relative URL for the logo of your project\n\n      \"edit\": null,                          // Edit URL template. Use this format for GitHub:\n                                             // \"http://github.com/username/repository/edit/master/%filename%\"\n\n      \"copyright\": \"© %Y Your Company Here\"  // Copyright for your project filtered through strftime\n\n      \"sections\": [                          // Sections for the navigation \n        { \"name\": \"Guidelines\", \"key\": \"guidelines\" },\n        { \"name\": \"Components\", \"key\": \"components\" }\n      ],\n\n      \"packages\": [                          // Package sets for code previews\n        {\n          name: 'oxygen',\n          styles: [ 'http://oxygencss.com/styles/site.css' ],\n          scripts: [ 'http://oxygencss.com/styles/site.js' ]\n        }\n      ]\n    }\n\n\n## Composing articles\n\nArticles are created by putting markdown files in your source directory. By default this is `src` in the root of your project, but it can be configured in the Glyder configuration file (`glyder.json`). All markdown files must use the \".md\" file extension.\n\nGlyder articles must include front matter. By default the title key is the only required frontmater option:\n\n    ---\n    title: My article\n    ---\n\n    Markdown contents here\n\nFrontmater options include:\n\n| Key            | Description |\n| :------------  | :---------- |\n| **title**      | The title of the article. This appears as an H1 at the top of the page. |\n| **section**    | The section in the side navigation where this article should appear. Sections are reference by key and can be declared in your Glyder config. |\n| **index**      | Used to order the navigation within a section in the sidebar. Lower values are sorted first. And then by the title of the article. By default articles have a index value of 100. |\n| **noHeading**  | Do not output the title. Instead rely on the author to include it in the Markdown portion of the article. |\n| **redirectTo** | Redirect to a specific URL. Implemented with an HTML meta refresh tag. |\n\n\n## Development server\n\nTo bring up a lightweight developement server to preview your project, use the `serve` command:\n\n    glyder serve\n\nThis will launch a preview server here:\n\n  \u003chttp://localhost:9000\u003e\n\nYou must use the glyder command from the root directory of the project.\n\n\n## Building HTML\n\nTo generate a site in the build directory (specified in the config), use the `build` command:\n\n    glyder build \n\n\n## Made with Gulp\n\nGlyder is really a frontend for a bunch of [Gulp][gulp] tasks that combine to make a flexible style guide generator. If you are familiar with Gulp, you should find it fairly easy to contribute.\n\n\n## Acknowledgements\n\nOriginally based on code from [John Long's styleguide repo][styleguide] with improvements by [Michael Lee][mlee].\n\n[styleguide]: https://github.com/jlong/styleguide\n[mlee]: https://github.com/michaellee\n[gulp]: http://gulpjs.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlong%2Fglyder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjlong%2Fglyder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlong%2Fglyder/lists"}