Skip to content
This repository has been archived by the owner on Jul 16, 2020. It is now read-only.

Commit

Permalink
Move docs from gh-pages to docs/ directory (palantir#1494)
Browse files Browse the repository at this point in the history
* Ignore docs directory when publishing to npm

* Add all docs content from gh-pages branch to docs/ directory

* Update docs on docs

* Update docs build script
  • Loading branch information
jkillian authored Aug 18, 2016
1 parent 3620d87 commit ebb4c99
Show file tree
Hide file tree
Showing 200 changed files with 19,683 additions and 1 deletion.
1 change: 1 addition & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ circle.yml
Gruntfile.js
tslint.json
/build/
/docs/
/src/
/test/
tscommand*.txt
3 changes: 3 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
ruby '2.2.3'
source 'https://rubygems.org'
gem 'github-pages'
20 changes: 20 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Site settings
title: TSLint
email: [email protected]
description: > # this means to ignore newlines until "baseurl:"
TSLint documentation. A linter for the TypeScript language.
baseurl: "/tslint" # the subpath of your site, e.g. /blog/
url: "https://palantir.github.io/" # the base hostname & protocol for your site
twitter_username: PalantirTech
github_username: palantir/tslint

# Build settings
markdown: kramdown
markdown_ext: md
exclude: [vendor]

page_gen:
- data: rules
template: rule
name: ruleName
dir: rules
26 changes: 26 additions & 0 deletions docs/_data/develop_sidebar.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"title": "Develop",
"url": "/develop",
"links": [
{
"title": "Custom Rules",
"url": "/custom-rules/"
},
{
"title": "Custom Formatters",
"url": "/custom-formatters/"
},
{
"title": "Contributing",
"url": "/contributing/"
},
{
"title": "Docs Development",
"url": "/docs/"
},
{
"title": "Testing Rules",
"url": "/testing-rules"
}
]
}
Loading

0 comments on commit ebb4c99

Please sign in to comment.