Commit Graph

65 Commits

Author SHA1 Message Date
Jennifer Thakar
98136e0f6d
Add href to compatibility callout toggle (#625)
This will ensure browsers allow the toggles to be tabbed to.

Fixes #598.
2022-08-22 13:19:09 -07:00
Natalie Weizenbaum
9e2dc02e25
Update to the latest version of DocSearch (#593) 2021-11-13 01:48:19 +00:00
Natalie Weizenbaum
85a2eaa33d Build JS API docs from the TypeScript declarations 2021-10-04 19:53:08 -07:00
tatianamac
2d166d3b10 Fix keyboard focus and aside issues 2019-12-18 16:08:14 -08:00
Natalie Weizenbaum
19aede2a01 Link to URLs without ".html" at the end 2019-12-18 16:00:40 -08:00
Natalie Weizenbaum
3cde415281 Document the Sass migrator
Closes #358
2019-09-25 14:53:13 +01:00
Natalie Weizenbaum
4a02f04717 Document new built-in functions
Closes #365
2019-09-24 11:36:43 +01:00
Natalie Weizenbaum
b1b07540f2 Module-ify built-in function documentation
Closes #363
2019-09-04 17:56:16 -07:00
Natalie Weizenbaum
029520349a Rename /documentation/functions to /documentation/modules
This hierarchy is now going to document built-in modules, which mostly
contain functions but can also contain mixins and may potentially
contain variables in the future.
2019-09-04 15:24:22 -07:00
Natalie Weizenbaum
b771e2297e Avoid an unstyled rendering moment with code examples
This renders the tabs and all the jQuery classes server-side, so that
the code examples are rendered correctly on the page's first load
rather than waiting for the JavaScript to activate. This also has a
side effect of making them look correct with JavaScript disabled.

This also adds a little additional styling in the noscript stylesheet
to make code examples look better on a narrow viewport with JavaScript
disabled.
2019-04-12 02:12:00 -07:00
Natalie Weizenbaum
e7ffef4fc9 Avoid an unstyled rendering moment with the tables of contents
Tables of contents are now statically rendered in their appropriately
open/closed states, rather than updated via JavaScript, so they render
correctly on the first page load. In order to make the "page sections"
table still usable without JS, this adds a stylesheet in a <noscript>
tag that forces the sections into an open state.
2019-04-12 00:09:10 -07:00
Natalie Weizenbaum
de561b2370
Make the reference tables of contents collapsible (#320) 2019-04-11 15:30:10 -07:00
Natalie Weizenbaum
be95e0c7df Allow examples to split even if they can't split in the middle 2019-03-28 19:13:31 -07:00
Natalie Weizenbaum
f56c48cafc Render syntax examples using adjacent tabs if they're narrow enough
Closes #311
2019-03-28 19:13:22 -07:00
Natalie Weizenbaum
416f463590 Properly display newlines in function signatures 2019-03-19 13:56:21 -07:00
Natalie Weizenbaum
e22698388e
Merge branch 'wip.reference' into function-return 2019-03-19 13:40:00 -07:00
Natalie Weizenbaum
78429ae1b4
Add permalink icons to function API docs (#309)
Closes #308
2019-03-18 17:49:03 -07:00
Natalie Weizenbaum
1d718a3fb3
Merge branch 'wip.reference' into function-return 2019-03-10 23:23:00 -07:00
Natalie Weizenbaum
d0c1079b78
Merge branch 'wip.reference' into impl-status 2019-03-10 23:22:02 -07:00
Natalie Weizenbaum
47c4de8279 Always get rid of newlines when concatenating chunks of HTML
This avoids weirdness with HTML within Markdown.
2019-03-08 17:52:45 -08:00
Natalie Weizenbaum
4c58ef0739 Add a partial support state for impl statuses 2019-03-08 17:11:11 -08:00
Natalie Weizenbaum
482542ac08 Add a header for impl status bars
This gives us a place to disambiguate between implementation statuses
that refer to the entire feature under discussion, and those that just
refer to sub-features.
2019-03-08 16:48:27 -08:00
Natalie Weizenbaum
7fd5bd1c7a Tweak impl status styling
* Make the font smaller to make them less prominent and help visually
  associate the callout with the list.
* Decrease the top margin to more clearly associate them with their
  preceding header.
* Lighten the callout background when in another callout to make it
  more visible.
* Animate the expand button.
2019-03-08 16:45:43 -08:00
Natalie Weizenbaum
681d63c698 Follow the style guide for implementation notes 2019-03-08 15:26:48 -08:00
Jina Anne
ac992b3233 implementation 2019-03-04 18:29:20 -08:00
Natalie Weizenbaum
40e116a9ed Include return types in function signatures
Closes #298
2019-03-04 18:28:38 -08:00
Jina Anne
24fd1d9dd3 type tweak 2019-03-04 17:51:45 -08:00
Jina Anne
03372dc401 style functions 2019-03-04 17:19:06 -08:00
Jina Anne
94c9c002ec make call outs less… called out 2019-03-04 16:24:31 -08:00
Natalie Weizenbaum
8805a7ce33 Enable Algolia search (#289)
* Enable Algolia search

This adds:

* Algolia bootstrap JS.
* A search bar (without styling)
* A "docSearch-content" class to the main reference doc container, so
  the sidebars don't get indexed.
* A "docSearch-function" class to function names, so that they'll be
  indexed.

* Fix a few lints
2019-03-04 15:05:59 -06:00
Natalie Weizenbaum
62fa63b67a Fix some typos 2019-01-04 15:04:18 -05:00
Jina Anne
c21200ba14 header linking 2018-12-28 17:59:53 -08:00
Natalie Weizenbaum
7f886f13ee Link to GitHub for Ruby Sass release notes 2018-12-28 15:45:13 -08:00
Natalie Weizenbaum
25a40e45f9 Pad the syntax switcher with newlines rather than CSS padding (#266)
* Pad the syntax switcher with newlines rather than CSS padding

* Style nit
2018-12-28 14:57:14 -08:00
Natalie Weizenbaum
6b015247a3 Document passing special functions to rgb() and hsl()
Closes #253
2018-12-03 18:39:07 -08:00
Natalie Weizenbaum
459af4324e Document the new rgb() and hsl() syntax
Closes #251
2018-12-03 17:25:01 -08:00
Natalie Weizenbaum
f34a7b87a6
Add a table of contents to select documentation pages (#260) 2018-11-29 15:43:18 -08:00
Natalie Weizenbaum
29c32eec1a Merge remote-tracking branch 'origin/wip.reference' into wip.reference 2018-10-31 16:05:52 -07:00
Natalie Weizenbaum
997c3a7ecd Document the JavaScript API 2018-10-31 16:02:04 -07:00
Jina Anne
7b26d6b684 clean up functions update intended code style in style guide 2018-10-26 21:35:30 -07:00
Natalie Weizenbaum
bfa0d22479 Merge remote-tracking branch 'origin/wip.reference' into wip.reference 2018-10-23 17:30:02 -07:00
Natalie Weizenbaum
0635a3bf61 Add documentation for selector functions 2018-10-23 17:24:13 -07:00
Jina Anne
3f1c2d338d lots of clean up 2018-10-23 15:06:39 -07:00
Natalie Weizenbaum
9ef5ceded1 Add the ability to indent in ERB blocks 2018-10-23 13:42:40 -07:00
Natalie Weizenbaum
e397f98b29 Fix Markdown rendering between examples 2018-10-23 12:09:24 -07:00
Natalie Weizenbaum
4b1788bfc4 Linkify function return types 2018-10-22 18:33:19 -07:00
Natalie Weizenbaum
67f7dd5dc3 Get rid of extra empty <p> tags 2018-10-22 17:26:00 -07:00
Natalie Weizenbaum
fc34fe4b75 Some colors function docs 2018-10-22 14:24:05 -07:00
Natalie Weizenbaum
efc113ec86 [WIP] Reference 2018-09-27 16:05:00 -07:00
Natalie Weizenbaum
56f97b7751 Merge branch 'example-helper' into wip.reference 2018-08-30 14:45:16 -07:00