Commit graph

134 commits

Author SHA1 Message Date
Yangshun Tay
55e676cb25
misc: add command to run prettier on docs (#2102)
* misc: add command to run prettier on docs

* Fix GH issue template

* Fix tests

* Add prettier-docs command to precommit
2019-12-07 21:56:30 -08:00
Endi
bcf39019f7
chore: v2.0.0-alpha.39 changelog & docs (#2101)
* chore: v2.0.0-alpha.39 changelog & docs

* remove useless
2019-12-07 13:12:04 +07:00
Endi
fb77c1c137
chore: v2.0.0-alpha.38 changelog & docs (#2094)
* chore: v2.0.0-alpha.38 changelog & docs

* nits
2019-12-06 14:03:24 +07:00
Endi
32c9d07b90
perf(v2): improve dev build time by not overwriting file if possible (#2089)
* perf(v2): improve sequential build time by not overwriting file if possible

* minor improvement

* docs
2019-12-06 12:17:41 +07:00
Yangshun Tay
4927f764e5 misc(v2): nitpicky formatting 2019-12-04 00:55:52 -08:00
endiliey
0e23e4ce32 docs(v2): fix typo in lifecycle api docs 2019-11-30 15:46:46 +07:00
Endi
97491c5cfb
feat(v2): injectHtmlTags API to inject head and/or body html tags (#2057)
* wip: define html tag definition

* feat(v2): implement injectHtmlTags api

* remove useless file

* nits

* documentation

* allow string, use prebodyTags and postBodyTags

* typo

* refactor typing

* chore(v2): bump deps
2019-11-30 11:52:26 +07:00
Endi
522dd2d206 docs(v2): quick proofread docs (#2068) 2019-11-29 12:26:49 -08:00
Endi
3b060ad171
docs(v2): add manual migration guide for versioning (#2047)
* docs(v2): add manual migration guide for versioning

* fix typo

* review
2019-11-29 11:48:04 +07:00
endiliey
2f9a368da8 chore: fix typo 2019-11-29 10:41:19 +07:00
endiliey
2856b328a5 chore(v2): fix typo in docs, remove dead/redundant stuff 2019-11-26 16:49:58 +07:00
Endi
91b261af7a docs(v2): more examples on lifecycle apis, cleanup (#2051)
* docs(v2): more examples on lifecycle apis, cleanup

* typo
2019-11-25 10:31:57 -08:00
Alexey Pyltsyn
91ef5c67cf
docs(v2): make proper spelling of Stack Overflow (#2053) 2019-11-25 16:50:00 +03:00
Wei Gao
2254e08785 docs(v2): Reorganize migration guide (#2036)
* reorganize migration guide headings

* wip about <AUTOGENERATED_TABLE_OF_CONTENTS>

* add description about AUTOGENERATED_TABLE_OF_CONTENTS

* Update website/docs/migrating-from-v1-to-v2.md
2019-11-25 19:45:22 +07:00
Endi
421f862701 breaking(v2): required nodejs version >=8.9 -> >=8.10 so we can use es2017 (#2045) 2019-11-24 21:40:57 -08:00
Endi
160f6f53e0
docs(v2): add documentation on versioning (#2038)
* docs(v2): add documentation on versioning

* Proofread

* add section on using absolute import
2019-11-24 18:01:48 +07:00
Endi
9862a6821a feat(v2): allow non sidebar category to be first item of sidebar (#2032)
* feat(v2): allow non sidebar category to be first item of sidebar

* better error messages

* edit the react component

* Update website/docs/sidebar.md

* nits

* add @babel/plugin-transform-runtime
2019-11-23 20:08:19 -08:00
Endi
c533adc4aa docs(v2): display yarn and npm command on website (#2037)
* docs(v2): display yarn and npm command on website

* more

* fix div cannot be descendant p
2019-11-23 18:32:26 -08:00
Endi
9829f56b1e
feat(v2): docs versioning ❄️🔥 (#1983)
* wip: versioning

* wip again

* nits lint

* refactor metadata code so that we can have inobject properties optimization, fix typing

* remove buggy permalink code

* modify versioned docs fixture such that foo/baz only exists in v1.0.0

* refactor metadata.ts so that there is less transformon object

* more refactoring

* reduce test fixtures, refactoring

* refactoring readability

* finish metadata part

* refactor with readdir

* first pass of implementation

* fix mdx laoder

* split generated routes by version for performance & smaller bundle

* test data for demo

* refactor with set

* more tests

* typo

* fix typo

* better temporary ui

* stronger typing & docsVersion command

* add 100% test coverage for docsVersion command

* more test and delete manual docs cut

* cut 2.0.0-alpha.35 docs

* cut alpha.36 instead

* copyright

* delete versioned docs

* stronger test on metadata

* update typo
2019-11-22 16:17:40 +07:00
endiliey
21e95f8640 chore(v2): docs for 2.0.0-alpha.36 2019-11-22 12:39:02 +07:00
Yangshun Tay
65965e060a misc(v2): change blog front matter to snake_case (#1989)
* misc(v2): change blog front matter to snake_case

* Fix blog image url

* Add docs for change

* More migration docs
2019-11-19 15:08:53 +07:00
Yangshun Tay
edf4c16c93 feat(v2): allow hiding docs table of contents (#2012)
* feat(v2): allow hiding docs table of contents

* move to frontmatter
2019-11-19 15:08:45 +07:00
yangshun
29ce98c63a docs(v2): misc updates 2019-11-17 05:44:21 -08:00
endiliey
8c3cae35e3 chore(v2): changelog 2019-11-17 16:51:02 +07:00
Alexey Pyltsyn
472a1a660c docs(v2): fix syntax highlighting for YML code blocks (#1988) 2019-11-13 15:43:01 -08:00
Vincent van der Walt
245b50f6e0 docs(v2): Add section to blog document about feed location (#1976)
* Add section in blog doc about feed location

* fix fenced code type
2019-11-13 13:10:20 +07:00
Jamie Davenport
ffa6b71b1d docs(v2): update configureWebpack utility functions (#1970) 2019-11-12 17:35:12 +07:00
Alexey Pyltsyn
6546c194fb feat(v2): add ability specify link in footer logo (#1965)
* feat(v2): add ability specify link in footer logo

* Refactor according review
2019-11-12 16:25:06 +07:00
Eric Carboni
b027db1b34 docs(v1): remove exclusive language (#1961)
* Initial commit to replace easy, easily, simple, just, of course

* Revert ordered list change
2019-11-11 14:06:54 -08:00
endiliey
5c652aacba chore(v2): 2.0.0-alpha.34 changelog 2019-11-11 21:34:41 +07:00
Endi
6a3efd5f3d
breaking(v2): editUrl should point to website instead of docsDir to support editUrl in versioning/trans (#1958) 2019-11-11 21:24:04 +07:00
Alexey Pyltsyn
9e290c9b43 feat(v2): add ability disable dark mode toggle (#1956) 2019-11-11 04:41:54 -08:00
Endi
3be2e86546
chore: bump dev dependencies (#1955)
* chore: bump devdeps

* upd infima url
2019-11-11 17:44:26 +07:00
Yangshun Tay
72792a1e5c
fix(v2): update Infima website URL (#1953) 2019-11-09 01:09:41 +08:00
endiliey
87f864e5ba chore(v2): changelog for 2.0.0-alpha.33 2019-11-08 13:45:02 +07:00
Pawel Kadluczka
ff83e6f8bc feat(v2): Implement plugin creating feed for blog posts (#1916)
* feat(v2): Implement feed for blog posts

Fixes: #1698

Test plan:
- added tests

Ran `yarn build` on website with the following config (and disabled blog
from preset-classic):

```js
[
'@docusaurus/plugin-content-blog',
  {
    path: '../website-1.x/blog',
    feedOptions: {
      copyright: 'Copy',
      type: 'atom',
    },
  },
],
```
which genereted the following feed:
```xml
<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
    <id>https://v2.docusaurus.io/blog</id>
    <title>Docusaurus Blog</title>
    <updated>2018-12-14T00:00:00.000Z</updated>
    <generator>https://github.com/jpmonette/feed</generator>
    <link rel="alternate" href="https://v2.docusaurus.io/blog"/>
    <subtitle>Docusaurus Blog</subtitle>
    <icon>https://v2.docusaurus.io/img/docusaurus.ico</icon>
    <rights>Copy</rights>
    <entry>
        <title type="html"><![CDATA[Happy 1st Birthday Slash!]]></title>
        <id>Happy 1st Birthday Slash!</id>
        <link href="https://v2.docusaurus.io/blog/2018/12/14/Happy-First-Birthday-Slash"/>
        <updated>2018-12-14T00:00:00.000Z</updated>
        <summary type="html"><![CDATA[![First Birthday Slash](/img/docusaurus-slash-first-birthday.svg)]]></summary>
    </entry>
    <entry>
        <title type="html"><![CDATA[Towards Docusaurus 2]]></title>
        <id>Towards Docusaurus 2</id>
        <link href="https://v2.docusaurus.io/blog/2018/09/11/Towards-Docusaurus-2"/>
        <updated>2018-09-11T00:00:00.000Z</updated>
        <summary type="html"><![CDATA[Docusaurus was [officially announced](https://docusaurus.io/blog/2017/12/14/introducing-docusaurus) over nine months ago as a way to easily build open source documentation websites. Since then, it has amassed over 8,600 GitHub Stars, and is used by many popular open source projects such as [React Native](https://facebook.github.io/react-native/), [Babel](https://babeljs.io/), [Jest](https://jestjs.io/), [Reason](https://reasonml.github.io/) and [Prettier](https://prettier.io/).]]></summary>
    </entry>
    <entry>
        <title type="html"><![CDATA[How I Converted Profilo to Docusaurus in Under 2 Hours]]></title>
        <id>How I Converted Profilo to Docusaurus in Under 2 Hours</id>
        <link href="https://v2.docusaurus.io/blog/2018/04/30/How-I-Converted-Profilo-To-Docusaurus"/>
        <updated>2018-04-30T00:00:00.000Z</updated>
        <summary type="html"><![CDATA[> _“Joel and I were discussing having a website and how it would have been great to launch with it. So I challenged myself to add Docusaurus support. It took just over an hour and a half. I'm going to send you a PR with the addition so you can take a look and see if you like it. Your workflow for adding docs wouldn't be much different from editing those markdown files.”_]]></summary>
    </entry>
    <entry>
        <title type="html"><![CDATA[Introducing Docusaurus]]></title>
        <id>Introducing Docusaurus</id>
        <link href="https://v2.docusaurus.io/blog/2017/12/14/introducing-docusaurus"/>
        <updated>2017-12-14T00:00:00.000Z</updated>
        <summary type="html"><![CDATA[![Introducing Slash](/img/slash-introducing.svg)]]></summary>
    </entry>
</feed>
```

* new feedOptions type 'all' and use correct path
2019-11-06 14:45:31 +07:00
Alexey Pyltsyn
c507028cb0
feat(v2): add ability default lang for code blocks (#1910)
* feat(v2): add ability default lang for code blocks

* Add support for CodeBlock

* changelog

* more changelog

* Add checks

* docs

* docs

* Fix changelog

* revert config

* Update theme-classic.md

* Update packages/docusaurus-theme-classic/src/theme/CodeBlock/index.js

Co-Authored-By: Endi <endiliey@gmail.com>
2019-11-05 10:36:22 +03:00
endiliey
5909b49915 chore(v2): changelog 2019-11-04 12:56:10 +07:00
Kate Bartolo
3f8cb78ba9 docs(v2): theme, plugin, and preset config (#1929)
* docs(v2): theme, plugin, and preset config

* change tabs to spaces

* change theme example
2019-11-03 17:59:39 +08:00
Alexey Pyltsyn
b8335fe925 docs(v2): fix typos (#1930) 2019-11-02 08:12:04 +08:00
Joel Ibaceta
472c8fc176 docs(v2): fix typo in advanced plugins (#1926) 2019-11-01 08:54:41 +08:00
Endi
16f10dd32a
docs(v2): Redirect component for easy redirect (#1913)
* docs(v2): Redirect component for easy redirect

* typo

* docs

* Update website/docs/docusaurus-core.md

Co-Authored-By: Alexey Pyltsyn <lex61rus@gmail.com>

* Update docusaurus-core.md
2019-10-30 10:19:30 +07:00
Endi
64871b76e4 fix(v2): custom searchbar should appear even if themeconfig.algolia is undefined (#1909)
* fix(v2): custom searchbar should appear even if themeconfig.algolia is undefined

* nits

* Docs docs

* inaccuracy

* changelog

* nits
2019-10-30 08:51:53 +08:00
Dylan Myers
f853171791 docs(v2): add windows batch instructions for publishing to gh pages (#1914)
* docs: add windows batch instructions for publishing to gh pages

* docs: add windows batch instructions on the v2 website
2019-10-29 23:49:01 +07:00
Yangshun Tay
f635f9aba2
docs(v2): code block line highlighting (#1904)
* docs(v2): code block line highlighting

* misc: update CHANGELOG

* misc: respond to review

* docs: add line highlighting to the template
2019-10-29 14:59:24 +08:00
Endi
2bbfbf88d6
docs(v2): update plugins, presets and themes docs (#1889)
* docs(v2): update plugins, presets and themes docs

* ideal image plugin

* proof reading

* Merge master
2019-10-26 15:10:48 +07:00
endiliey
242c9e0c29 chore(v2): update docs and changelog 2019-10-26 14:16:04 +07:00
Endi
a9f752cf23
docs(v2): update config docs (#1885) 2019-10-25 23:35:02 +07:00
Endi
a149f775ad
docs(v2): add docs on useful client api (#1890)
* docs(v2): add docs on useful client api

* Update docusaurus-core.md

* Update website/docs/docusaurus-core.md

* Update website/docs/docusaurus-core.md

* Update website/docs/docusaurus-core.md

* Update website/docs/docusaurus-core.md
2019-10-25 23:25:43 +07:00
Alexey Pyltsyn
11548da4cd docs(v2): fix format inline code (#1888) 2019-10-25 21:46:06 +07:00