Kevin Lacker
455d2d1b48
New Documentation
2016-10-21 20:59:08 +01:00
Alex Zherdev
11c0adcc95
Fix header link generation for non-English docs ( #7497 )
2016-08-18 14:55:50 -07:00
Daniel Lo Nigro
6d537e939f
Upgrade to Jekyll 3
...
Full list of changes is at https://jekyllrb.com/docs/upgrading/2-to-3/ . The tl;dr of it is:
- Relative permalinks were removed, so all the files in the `docs` subdirectory need their permalink to be prefixed with `docs/`
- `post` and `page` types were renamed to `posts` and `pages` respectively
- `jekyll-paginate`, `pygments` and `redcarpet` are all now optional, so I needed to explicitly add it to the Gemfile. Jekyll now uses `rouge` rather than `pygments` for syntax highlighting, but rouge does not support highlighting individual lines (`hl_lines`) so we need to continue using Pygments.
- Layout metadata (eg. `sectionid`) is now on a `layout` variable rather than `page`
Tested the following pages and confirmed that they all work:
- "Docs" link (getting started page): http://127.0.0.1:4000/react/docs/getting-started.html
- Downloads: http://127.0.0.1:4000/react/downloads.html
- Tutorial: http://127.0.0.1:4000/react/docs/tutorial.html
- A few pages under the "docs" subdirectory, to confirm they're working properly:
- http://127.0.0.1:4000/react/docs/addons.html
- http://127.0.0.1:4000/react/docs/why-react.html
- http://127.0.0.1:4000/react/docs/create-fragment.html
- A few tips:
- http://127.0.0.1:4000/react/tips/false-in-jsx.html
- http://127.0.0.1:4000/react/tips/style-props-value-px.html
- Non-English versions of the page:
- http://127.0.0.1:4000/react/docs/getting-started-it-IT.html
- http://127.0.0.1:4000/react/docs/getting-started-ja-JP.html
2016-07-19 12:18:49 -07:00
Paul O’Shannessy
ab6041bad6
Don't add class="" if we don't need to
2016-02-29 16:30:03 -08:00
Joe Critchley
8886cee285
Added icon for external links in Docs nav and unlinked Complementary Tools and Examples in favor of this icon
2016-02-23 02:18:20 +00:00
Jim
5ae4f035c7
Fix blog post authors
2015-10-14 18:01:33 -07:00
Paul O’Shannessy
b0bf35a361
[docs] Use a generator to assign complete author data before generating site
...
This makes sure that `post.author` will be the actual data we want and we don't have to assign it every time, potentially messing it up.
2015-09-14 19:55:01 -07:00
Paul O’Shannessy
6c19040d24
Point to Flux site for Flux docs
...
This doesn't actually remove the pages, just the main content. Sidebar
items now link offsite. The pages doesn't automatically redirect, but we
could do that if we really wanted.
Fixes #2229
2014-09-25 12:34:22 -07:00
Ben Alpert
e94ebee15e
Make doc headers clickable again
...
...without preventing clicks on other things.
Just use an `<a name="...">` tag that doesn't take up any space to make sure that we're not covering up something else.
For whatever reason, doing `position: relative; top: -$navHeight;` doesn't work and causes the anchor target not to be moved up. This solution works in both Chrome and Firefox.
2013-11-18 17:34:44 -08:00
Ben Alpert
25ba629098
Move heading anchors 50px up to avoid nav bar
...
Fixes #447 .
We do this by moving the actual anchored element up in the page without moving the actual text. (Apple uses a similar trick in their framed docs.) Now this looks a bit sillier on smaller screens but it's better overall.
2013-10-28 13:52:58 -07:00
Cheng Lou
99dcdb87e3
Add clickable anchors to docs headers
...
Closes #434
2013-10-21 14:27:31 -07:00
Paul O’Shannessy
d27746ee0b
Docs: Give headers ids for easy linking
...
This gives markdown headers an id so that we can link directly to
sections of our docs. This is better than the alternative of adding them
all ourselves.
2013-09-23 10:30:51 -07:00
Paul O’Shannessy
75897c2dcd
Initial public release
2013-05-29 12:54:02 -07:00
