29 Commits

Author SHA1 Message Date
Joey Perrott
32b8832d61 docs: include source code styling section in docs style guide ()
Include a source code styling section in the style guide for docs,
indicating to follow the Angular style guide where possible and
defining hexidecimal style guidance.

Closes 

PR Close 
2021-05-24 17:38:02 +00:00
Pete Bacon Darwin
3a48c0739d build(docs-infra): ensure that terminal code snippets render correctly ()
After the changes to the `lang-none` styling in , code snippets marked with

```
language="none" class="code-shell"
```

were being styled with the same foreground and background colours.

It turns out that most of these ought to be marked `language="sh"`
in which case the `code-shell` style became redundant and has been
removed.

Fixes 

PR Close 
2021-05-07 13:11:04 -04:00
Kapunahele Wong
f76f2eb381 docs: update docs-style-guide ()
This commit updates the documentation style guide
so that it is in line with current standards, those
of Google as well as those within the Angular docs.

PR Close 
2021-02-09 14:26:06 -08:00
Gerald Lang
713fb3b587 docs(docs-infra): fix small typo ()
The style guide docs had a typo "Alerts and Calllouts". Callouts is
spelled with two l's, not three. This PR fixes the typo.

PR Close 
2020-06-08 14:42:49 -07:00
Judy Bogart
75dff8a93a docs: improve startup nav, naming, and terminology ()
PR Close 
2020-04-22 17:08:29 -04:00
Judy Bogart
efdf347f9c docs: apply standard header case convention ()
PR Close 
2020-01-10 08:38:53 -08:00
Stefanie Fluin
fe4447d568 feat(docs-infra): simplify image styles and remove figure references ()
Reference 
Removes figures elements as AIO is not typically using captions or image groups where figures would be necessary or appropriate

PR Close 
2019-11-14 09:27:02 -08:00
thanhpd
2f6c97e93c docs: remove redundant whitespaces and fix minor typos ()
PR Close 
2019-10-29 11:39:17 -07:00
Judy Bogart
088435c5eb docs: emphasize headers for code examples ()
PR Close 
2019-10-01 14:45:29 -07:00
George Kalpakas
1bcd58cee8 refactor(docs-infra): remove linenums=false since it is now the default ()
PR Close 
2019-07-24 14:38:54 -07:00
George Kalpakas
dd0be7feb7 fix(docs-infra): always default to no linenums in <aio-code> ()
Previously, `linenums` defaulted to true if the content was more than 10
lines long and false otherwise.

Since in most cases linenums add unnecessary visual noise, this commit
changes `linenums` to always default to false (regardless of the size of
the content). It can be still be turned on by explicitly setting to true
or a number.

PR Close 
2019-07-24 14:38:54 -07:00
Kapunahele Wong
352f9672c0 docs: add no-auto-link instructions to docs style guide ()
PR Close 
2019-06-13 17:00:46 -07:00
jenniferfell
411c505dae docs: update authors style guide to highlight related guidelines and position these guidelines ()
PR Close 
2019-04-09 12:23:09 -07:00
William Marques
fc6dad40ac fix(docs-infra): rename "title" by "header" to avoid unwanted tooltips ()
Closes 

PR Close 
2018-10-17 11:05:29 -07:00
Stefanie Fluin
d523630ea2 docs(aio): cleanup aalert, callout, subsection use and author style ()
PR Close 
2018-07-24 08:22:14 -07:00
Georgios Kalpakas
24e0c3d43d docs: minor fixes in docs-style-guide () ()
PR Close 

PR Close 
2018-06-27 15:01:47 -07:00
George Kalpakas
b874501025 docs(aio): update live-example docs in authors style guide ()
PR Close 
2018-04-05 10:12:09 -07:00
musicq
d3c2aa5f95 docs: add missing underline ()
PR Close 
2018-02-02 07:49:32 -08:00
Jesus Rodriguez
1a75934cc0 build(aio): migrate plunker to stackblitz ()
PR Close 
2018-01-23 21:30:27 -08:00
George Kalpakas
bf248792eb docs: minor fixes (anchor tags, redundant whitespace, consistent code-snippets lang) ()
PR Close 
2018-01-18 18:22:20 -06:00
Ward Bell
7186c9c839 docs: AOT guide for CLI () 2017-11-02 14:34:21 -07:00
Sergey Koshechkin
93d23ddcc8 docs(aio): fix typo
PR Close 
2017-11-01 15:42:25 -04:00
George Kalpakas
ffceae0a01 refactor(aio): remove unnecessary -- from yarn commands 2017-09-25 14:37:13 -07:00
Ward Bell
a5ee653da0 docs: update README and author guide about doc build errors ()
- tells reader about `yarn serve-and-sync`.
- directs reader to look to docs-style-guide if get doc build error.
- update docs-style-guide to warn about ignored code files.

PR Close 
2017-09-20 12:35:31 -07:00
Shefali Sinha
92d7ecf627 docs: shefali edits to Authors Style Guide () 2017-07-05 14:33:06 -07:00
Ward Bell
96b17034e1 feat(aio): cross reference readme and docs styleguide 2017-06-29 09:35:04 -07:00
Ward Bell
37cdc4f759 docs(aio): ward's changes 2017-06-21 16:21:20 -07:00
Shefali Sinha
b1dab181e0 docs(aio): change to overall prose 2017-06-21 16:21:20 -07:00
Shefali Sinha
fd6c4e371b docs(aio): create author style guide 2017-06-21 16:21:20 -07:00