{"id":22475528,"url":"https://github.com/philips/fixiedocs","last_synced_at":"2025-08-02T11:32:38.268Z","repository":{"id":7736743,"uuid":"9103378","full_name":"philips/fixiedocs","owner":"philips","description":"Single page docs","archived":false,"fork":false,"pushed_at":"2013-04-08T19:04:34.000Z","size":3888,"stargazers_count":15,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-08T18:54:34.211Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://philips.github.io/fixiedocs/","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/philips.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":"2013-03-29T17:42:08.000Z","updated_at":"2019-08-13T13:31:16.000Z","dependencies_parsed_at":"2022-09-13T03:52:27.105Z","dependency_job_id":null,"html_url":"https://github.com/philips/fixiedocs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/philips/fixiedocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philips%2Ffixiedocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philips%2Ffixiedocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philips%2Ffixiedocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philips%2Ffixiedocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/philips","download_url":"https://codeload.github.com/philips/fixiedocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philips%2Ffixiedocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268378965,"owners_count":24240907,"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","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"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":[],"created_at":"2024-12-06T13:18:21.383Z","updated_at":"2025-08-02T11:32:37.948Z","avatar_url":"https://github.com/philips.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Fixie Docs\n\n\u003e Transform your markdown documentation into a single navigable html\n\u003e document.\n\n\u003ciframe width=\"560\" height=\"315\" src=\"http://www.youtube.com/embed/YsZijEx2Iyo?hd=1\" frameborder=\"0\" allowfullscreen\u003e\u003c/iframe\u003e\n\nThis tool takes a single markdown input file, named README.md by\nconvention, and turns it into a single html page. The target audience\nare people writing reference documentation for products, APIs or\nlibraries. It was written as a reaction to complex tools and inspired by\nsingle page docs like [express][express].\n\nNotable features:\n\n- Single input file\n- Auto-refresh on edits\n- Generated navigation\n- Simple build system\n- Open source (MIT)\n\nGive it a shot and let me know what you think.\n\n[express]: http://expressjs.com/api.html\n\n## Usage\n\nGet started by downloading the code and dependencies. This step you\nwill only need to run once.\n\n```\ngit clone https://github.com/philips/fixiedocs.git\ncd fixiedocs\nnpm install\n```\n\nNow the fun part: getting a preview of the document. In the same\nterminal run the following command to launch a server and open your\nbrowser.\n\n```\ngrunt server\n```\n\nThis browser preview will continue to update everytime you save a change\nto the README.md file. Lets try that out. Open the README.md file in\nyour favorite editor and start editing. If you aren't familiar with\nmarkdown you can find a [full guide here][markdown]. But, you should be\nable to infer the basics from reading the Fixie Docs README.md file.\n\n[upstream]: https://github.com/philips/fixiedocs\n[markdown]: http://daringfireball.net/projects/markdown/\n\n## Publishing\n\nIn most every case documentation is meant to be uploaded for anyone to\nread on the public internet. So, lets setup a nice automated process for\ngenerating your website on a public URL.\n\nLet's use GitHub's free static HTML hosting called [Pages][pages]. We\nwill generate the Pages when we commit a change to this git repo using\nTravis CI. It will be nice and automated.\n\n```\nyo travis-ci:gh-pages\n```\n\n[pages]: http://pages.github.com/\n\nBy default you should have a beautiful set of docs. However, you can\ncustomize the CSS, JavaScript and HTML too. All of it can be found in\nthe `app/` directory.\n\nFor example the HTML template will need to be customized if you wish to\nadd a title or analytics. The template file is called\n`app/template.jst`.\n\nTo generate an uploadable static version of the docs locally run the `grunt`\ncommand in your terminal.  This will output all of the necessary HTML, CSS and\nJavaScript to the `dist/` directory.\n\nThere are a ton of other great options for publishing the static\ndocumentation that is generated from Fixie Docs. Here are a few\nsuggestions:\n\n- [Amazon S3][s3]\n- [Google Storage][gs]\n- [Rackspace Cloud Files][cf]\n\n[s3]: http://stackoverflow.com/questions/8312162/static-hosting-on-amazon-s3-dns-configuration\n[gs]: https://developers.google.com/storage/docs/gsutil/commands/setwebcfg\n[cf]: http://www.rackspace.com/blog/rackspace-cloud-files-how-to-create-a-static-website/\n\n## Future Directions\n\nThere are a lot of features I would love to see. Here are some of them.\n\n- Extract code snippets into individual files for testing\n- Integrate the frontend code into jekyll\n- Improved responsive layouts\n- Better packaging\n- Use lunr to integrate filtering and searching: https://npmjs.org/package/lunr\n- Heirarchy in the sidebar like express js\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphilips%2Ffixiedocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphilips%2Ffixiedocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphilips%2Ffixiedocs/lists"}