https://github.com/sanssecours/natural-docs.tmbundle
Very basic TextMate support for NaturalDocs
https://github.com/sanssecours/natural-docs.tmbundle
Last synced: 3 months ago
JSON representation
Very basic TextMate support for NaturalDocs
- Host: GitHub
- URL: https://github.com/sanssecours/natural-docs.tmbundle
- Owner: sanssecours
- Created: 2013-04-25T08:34:28.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2016-10-12T12:34:41.000Z (over 8 years ago)
- Last Synced: 2025-03-15T04:05:07.020Z (3 months ago)
- Size: 161 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: ReadMe.md
Awesome Lists containing this project
README
# About #
This is a very basic [TextMate](https://github.com/textmate/textmate) bundle
for [Natural Docs](http://www.naturaldocs.org). At the moment this bundle
contains exactly one command which will generate documentation for your
current project in the sub-directory `ND_OUTPUT_DIRECTORY` (default value:
`Documentation`).
# Requirements #
## NaturalDocs ##
Installation via [Homebrew](http://mxcl.github.io/homebrew/):
```shell
brew install naturaldocs
```
# Variables #
* `ND_OUTPUT_DIRECTORY` — The sub-directory where the generated documentation will be saved (Default value: `Documentation`)
* `ND_PROJECT_DIRECTORY` — The project directory for Natural Docs (Default value: `.nd`)
# Installation #
```shell
# TextMate 2
cd ~/Library/Application\ Support/TextMate/Bundles/
git clone https://github.com/sanssecours/Natural%20Docs.tmbundle.git
```
# Usage #
Open a project containing Natural Docs Documentation and press `^⌘H` to
generate and display the current documentation.