{"id":13858540,"url":"https://github.com/code-lever/plans-gem","last_synced_at":"2025-07-27T04:05:30.147Z","repository":{"id":56888228,"uuid":"52174067","full_name":"code-lever/plans-gem","owner":"code-lever","description":"Command line application for creating markdown documents from templates and publishing them in MS Word.","archived":false,"fork":false,"pushed_at":"2016-02-20T22:53:09.000Z","size":791,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-30T12:23:00.687Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","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/code-lever.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}},"created_at":"2016-02-20T20:30:52.000Z","updated_at":"2019-03-03T21:09:30.000Z","dependencies_parsed_at":"2022-08-20T16:00:08.261Z","dependency_job_id":null,"html_url":"https://github.com/code-lever/plans-gem","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/code-lever/plans-gem","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-lever%2Fplans-gem","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-lever%2Fplans-gem/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-lever%2Fplans-gem/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-lever%2Fplans-gem/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/code-lever","download_url":"https://codeload.github.com/code-lever/plans-gem/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-lever%2Fplans-gem/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267298471,"owners_count":24065881,"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-07-27T02:00:11.917Z","response_time":82,"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-08-05T03:02:12.808Z","updated_at":"2025-07-27T04:05:30.129Z","avatar_url":"https://github.com/code-lever.png","language":"Ruby","readme":"# Plans\n\nCommand line application for creating markdown documents from templates and publishing them in MS Word.\n\n\u003e Plans are nothing; planning is everything. --Dwight D. Eisenhower\n\nPlans was originally created to manage functional specifications and scope documents for our projects. I prefer to write in [markdown](https://daringfireball.net/projects/markdown/), but many of our clients would prefer to review documents in MS Word. Plans (well [Pandoc](http://pandoc.org) really!) bridges that gap allowing us to create these documents in markdown and publish them in MS Word. It also allows us to manage our requirements documents more like code. We keep them all in git (either on [Github](https://github.com) or [Bitbucket](https://bitbucket.org)) and manage changes to them via pull requests. As a side benefit, the built in markdown browsing capabilities available on both BitBucket and GitHub are really handy. That's why, as you will see, most of the markdown files in the documents are named README.md. This way they are available in GitHub or BitBucket as the Readme file for the directory.\n\nPlans ships with templates (DOC_TYPEs) for managing the requirements for a typical project.\n\n* Vision and Scope document\n* Functional Specification\n* User Classes and Characteristics\n* Glossary\n* Plain Document \n\nThese are just examples and its easy to make your own templates. We also use plans to manage our proposals, agreements, and statements of work.\n\n## Prerequisites\n\nPlans has only been tested on MacOS. If you *really* want to use it in Windows, let me know.\n\nPlans depends on [Pandoc](http://pandoc.org) and [ImageMagik](http://imagemagick.org) to do a lot of the heavy lifting. These will need to be installed first.\n\nThere are many ways to do this, but probably the easiest is to use [Homebrew](http://brew.sh).\n\nOnce homebrew is installed, you can easily install Pandoc.\n\n    $ brew install pandoc\n    \nImageMagick works pretty much the same way.\n\n    $ brew install imagemagick\n\nYou also need Microsoft Word. :)\n\nPlans can also create PDFs. If you want to create PDFs of your markdown documents you will need to install a XeLaTeX engine for use by Pandoc. [BasicTex](https://tug.org/mactex/morepackages.html) will work. You can also install this with homebrew.\n\n    $ brew install Caskroom/cask/basictex\n\n## Installation\n\nInstall it:\n\n    $ gem install plans\n\n## Usage\n\nTo get started, try:\n\n    $ plans help\n    \nThis will show you what plans can do. It will also let you know if you have plans installed correctly.\n\nPlans allows you to define a set of document templates, or DOC_TYPEs. These are stored in your home directory in a `.plans` folder. To create this folder with a default set of documents do the following.\n\n    $ plans init\n\nThen take a look at the `.plans` directory in your home directory. If you want to customize the templates, check out the README.md in the root of the `.plans` directory.\n\nTo see what types of documents you can create do the following.\n\n    $ plans list\n\nTo create a new functional specification, do the following.\n\n    $ plans new functional\n\nYou can then edit the README.md that is created by plans. To turn that markdown document into MS Word, just navigate into the directory where the file is located and type:\n\n    $ plans publish\n\n### Images\n\nMaking an image heavy document in markdown can be kind of a pain and functional specifications for a user interface tend to have a lot of mockups, screenshots, and diagrams. With plans, you can just export those images to the `img` folder and include them like you would for markdown normally. Something like this:\n\n    ![A Screenshot](./img/Fullscreen_10_12_15__11_34_AM.png)\n\nThis is all well and good, but sometimes those images are huge and they don't get automatically resized in Word. Manually resizing all of the images in a Word document rapidly becomes very tedious.\n\nSo, plans uses Imagemagick to make reasonable sized versions of any images in your documents `img` folder. To learn more, try:\n\n    $ plans help thumbs\n\nPlans will make 200px, 400px, and 600px wide versions of these images. You can then include them in your document like this:\n\n    ![A Screenshot](./img/400px/Fullscreen_10_12_15__11_34_AM.png)\n\nNo more manually resizing images in Word!\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/code-lever/plans.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n","funding_links":[],"categories":["Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-lever%2Fplans-gem","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcode-lever%2Fplans-gem","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-lever%2Fplans-gem/lists"}