From 20c212fdf93b8dd42c73a5a0a84ac1c0af384d05 Mon Sep 17 00:00:00 2001 From: Tom MacWright Date: Wed, 25 Jan 2017 09:02:00 -0500 Subject: [PATCH] docs(changelog): Improve changelog - previous changelogs: March 22, 2016 * Fixes non-unique IDs on section headers. * You can now run `npm run build` multiple times without any problems. March 17, 2016 * Support for linking to specific languages. URLs were previously like `#the-section` but now are `?language=JavaScript#the-section` when a language is selected, so that you can link to both a specific section and a specific language. * Changes how Docbox uses highlight.js - instead of including tons and tons of languages, we include only a few. March 14, 2016 * Support for toggling between 1 and 2 column mode --- README.md | 4 ++++ package.json | 9 ++++++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7bdbd6f..d3492e0 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,10 @@ _Docbox is a [Mapbox](http://mapbox.com/) community open source project. We buil Documentation is written as Markdown files in the `content` directory, and is organized by the `src/custom/content.js` file - that file requires each documentation page and puts them in order. This demo has a little bit of content - [content/example.md](content/example.md) and [content/introduction.md](content/introduction.md), so that there's an example to follow. +## Testing-driven + +Docbox's test suite is an integral part of the design: it's designed to catch any error that would produce invalid documentation and also designed to be extended with custom rules for your documentation standards. Remember to run `npm test` if anything looks funky, and if you have a standard you want to enforce, to enforce it automatically by writing a test! + ## Customization All custom code - code that relates to brands and specifics of APIs - is in the `./src/custom` directory. Content is [src/custom/content.js](custom/content.js) and brand names & tweaks are in [src/custom/index.js](src/custom/index.js), with inline documentation for both. diff --git a/package.json b/package.json index d874ed8..cb7d3bf 100644 --- a/package.json +++ b/package.json @@ -48,15 +48,22 @@ "remark": "^5.0.1", "remark-html": "^5.0.0", "remark-slug": "^4.1.0", + "standard-changelog": "^0.0.1", "unist-util-select": "^1.3.0", "unist-util-visit": "^1.0.0" }, "devDependencies": { "babel-register": "^6.3.13", + "budo": "^8.2.2", + "cz-conventional-changelog": "1.2.0", "expect": "^1.13.4", "mocha": "^2.3.4", "to-vfile": "^1.0.0", - "budo": "^8.2.2", "uglifyjs": "^2.4.10" + }, + "config": { + "commitizen": { + "path": "./node_modules/cz-conventional-changelog" + } } }