{"id":15980651,"url":"https://github.com/drwpow/envy-docs","last_synced_at":"2025-04-04T18:44:48.902Z","repository":{"id":17342756,"uuid":"20114108","full_name":"drwpow/envy-docs","owner":"drwpow","description":"Lightweight, Markdown-powered Docs","archived":false,"fork":false,"pushed_at":"2014-05-27T06:11:59.000Z","size":160,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-10T04:17:33.450Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","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/drwpow.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":"2014-05-23T21:09:24.000Z","updated_at":"2014-09-11T20:45:56.000Z","dependencies_parsed_at":"2022-09-24T15:23:19.224Z","dependency_job_id":null,"html_url":"https://github.com/drwpow/envy-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drwpow%2Fenvy-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drwpow%2Fenvy-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drwpow%2Fenvy-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drwpow%2Fenvy-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/drwpow","download_url":"https://codeload.github.com/drwpow/envy-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247234850,"owners_count":20905852,"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-10-08T00:21:34.129Z","updated_at":"2025-04-04T18:44:48.887Z","avatar_url":"https://github.com/drwpow.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Envy Docs v1.0\n\nQuick and easy Markdown documentation, hosted via\n**[GitHub Pages](https://pages.github.com/)** ([directions below](#user-content-how-to-deploy)). \n\n## Demo\n\n**[dangodev.github.io/envy-docs](http://dangodev.github.io/envy-docs/)**\n\n### Version History\n\n**1.0** *(25 May 2014)*\n*   Initial styling\n*   TODO: responsive styles\n\n### Contents\n\n1.  Set Up\n2.  How to Write\n3.  How to Customize\n4.  How to Deploy\n5.  Credits\n\n## Set Up\n\n1. `gem install middleman`\n2. `git clone git@github.com:dangodev/envy-docs.git`\n3. `bundle`\n4. `middleman s`\n5. `open http://localhost:4567`\n\nYou’ll be working with the files in `/source/` only.\n\nIf you don’t know where to keep the docs in relation to your codebase, I\nrecommend keping them **separate from the codebase you plan on documenting**\n(ie, having `/my-app` and  `/my-app-docs` side-by-side). In most cases it’s\neasier to treat this documentation as a separate app with its own revisions\nand history, and you’ll only be copying build files over when you’re ready to\npublish.\n\n## How to Write\n\nMake a new file, and save it as an `.md` file.\n\nTo add your new markdown file to the navigation, include the following header\n(with dashes):\n\n```\n---\ntitle: Page Title\ntype: page\npriority: 3\n---\n```\n\n*  `title`: Declares the page title in the navigation and browser title\n*  `type`: This must be set to *page* in order to be added to the menu.\n*  `priority`: This sets the order in the left navigation (if it conflicts\n    with another item, they are sorted alphabetically)\n\n*Can I put files in sub-folders?*\n\nYes, you can put `.md` files anywhere. But the current version doesn’t support\nsub-children in the left navigation; regardless of their path they will all\nappear as individual navigation items.\n\n*Does it matter what I name the .md files?*\n\nNope.\n\n*Isn’t there more setup than that?*\n\nNope.\n\n## How to Customize\n\n### Colors\nThere are a few color options readily available in\n`assets/stylesheets/application.sass`. Beyond that, hack it up! All the\nstyles are in `application.sass`, and you’ll find the layout file itself in\n`layouts/layout.haml`.\n\n### Syntax Highlighting\nYou can change `Github` to any of the other available\n[themes](https://github.com/middleman/middleman-syntax#css) in\n`assets/stylesheets/code.html.erb`. You’re also free to contribute any\n[Rouge](https://github.com/jneen/rouge)-style syntax file if you need more\ncustomization.\n\n## How to Deploy\n\n### GitHub Pages\nWe’re assuming that this is documentation for another repo, so you’re going\nto be pushing your build files to an empty orphan branch named **gh-pages**\nin your repo.\n\nNavigate to your documentation directory, and run\n\n```\nmiddleman build\n```\n\nto generate static HTML. Then simply copy everything in this directory to an\nempty orphan branch named **gh-pages** in your app (`git checkout --orphan\ngh-pages`), and push to GitHub (`git push --set-upstream origin gh-pages`).\nThe rest is magic!\n\nView your public docs at: `http://[github-handle].github.io/[repo-name]`.\n\n*Will this work for private repos?*\n\nYes, this will work for private repos. The repo will still be entirely\nprivate, but the docs will be accessible to anyone (including the associated\nGitHub handle and repo name, unless you’ve configured a\n[domain](https://help.github.com/articles/setting-up-a-custom-domain-with-github-pages)).\n\n*What if my repo currently isn’t on GitHub?*\n\nThen make a free public repo on GitHub! Doesn’t matter if you have any\ncode within *master*, so long as the build files can be found within the\n**gh-pages** branch.\n\n### Other Hosting\n\nSimply run `middleman build` within your doc directory, and copy the static\nHTML files anywhere for ready-to-go documentation.\n\n## Credits\n\nThis uses [Middleman](http://middlemanapp.com/) to build, starting with Drew\nBarontini’s [Baseman](https://github.com/drewbarontini/baseman) configuration.\nIt also features Drew’s navigation helper.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrwpow%2Fenvy-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdrwpow%2Fenvy-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrwpow%2Fenvy-docs/lists"}