Commit graph

1999 commits

Author SHA1 Message Date
Endi
1591128cdd
refactor(v2): add typing for docs plugin (#1811)
* refactor(v2): add typing for docs plugin

* nits
2019-10-07 18:28:33 +07:00
Endi
f671e6b437
docs(v2): simple migration guide from v1-v2 (#1809)
* docs(v2): simple migration guide from v1-v2

* fix wrong info

* add gitignore section

* proofread migration guide

* typo

* publish dir

* proofread
2019-10-06 09:29:47 +07:00
Dattatreya Tripathy
a404732c30 docs(v2): blog initial draft (#1786)
* docs(v2): contributing for v2 #1640

* deleted blog.md

* docs(v2): contributing for v2 (#1640)

* docs(v2): blog (#1640)

* Update blog.md
2019-10-05 12:23:21 -07:00
Wei Gao
9eb725d53a docs(v2): make double nested sidebar entry thinner and smaller (#1756) 2019-10-05 12:06:48 -07:00
endiliey
7d5920b30c docs(v2): fix outdated/ wrong info 2019-10-05 15:39:22 +07:00
Michał Lytek
d5ca17ffea docs: fix showcase user TypeGraphQL website url (#1806) 2019-10-02 10:26:53 -07:00
endiliey
8d4def5c08 v2.0.0-alpha.25 2019-10-01 20:29:26 +07:00
Robert Kingston
e3ef48f957 docs(v1): showcase user Mojito (#1802) 2019-09-29 18:47:25 -07:00
endiliey
9806b44a6d chore: fix expired discord invite link 2019-09-25 17:05:54 +07:00
Dongwoo Gim
961eb44ab1 refactor(v2): add common typing package @docusaurus/types (#1797)
* add common typing package `@docusaurus/typing-common`
.

* change name to `@docusaurus/types`

* refactor `packages/docusaurus/src/server/types`

* use directly `index.d.ts`
.

* add missing dependency `@docusaurus/types` on `@docusaurus/core`

* add missing dependency `@types/webpack`

* fix mistaken type

* typing package move to dev dependency

* Update package.json

see https://stackoverflow.com/questions/45176661/how-do-i-decide-whether-types-goes-into-dependencies-or-devdependencies
2019-09-25 17:48:56 +08:00
Endi
0397f7b719
chore(v2): upgrade babel, webpack, and mdx (#1798)
* chore: upgrade babel, webpack, and mdx

* changelog
2019-09-24 18:55:07 +08:00
Rami
090b5c1393 docs: showcase user PayTabs (#1795) 2019-09-22 07:33:04 -07:00
Dongwoo Gim
4cecdc6db1 chore: add ts,tsx to lint-staged (#1796) 2019-09-22 21:25:52 +08:00
Lukas Gentele
464bab01aa docs(v1): add devpace to users (#1790) 2019-09-16 19:45:18 -07:00
Masafumi Koba
a1e02be3d3 docs: fix broken PR links (#1791) 2019-09-16 19:43:33 -07:00
Dongwoo Gim
78159f6dd5 refactor(v2): convert @docusaurus/plugin-content-blog to TypeScript (#1785)
* convert `@docusaurus/plugin-content-blog` to typescript

remove divided plugin
convert `@docusaurus/plugin-content-blog` to typescript
convert `@docusaurus/plugin-content-blog` to typescript
convert `@docusaurus/plugin-content-blog` to typescript
add `packages/docusaurus-plugin-content-blog/lib` to ignores
linted
refactoring type definition
fix test fails
lint

* lint
2019-09-16 23:46:57 +08:00
Yangshun Tay
0584407257
v1.13.0 (#1789) 2019-09-15 23:13:09 -07:00
Yangshun Tay
4d76d58e4b
chore(v1): upgrade deps (#1787) 2019-09-15 21:27:22 -07:00
Shirshendu Bhowmick
0bbf7b8202 refactor(v2): convert SearchBar to hooks (#1755)
* Refactored with Hooks

* refactored for improvements

* Added classnames for conditional CSS rendering
2019-09-14 11:32:46 -07:00
Emelia Smith
250a818e7f feat(v1): strip html from TOC (#1762)
The approach here is to first strip the HTML from the heading's content, then rendered it with markdown to get the HTML content for the TOC entry, then to strip the HTML from the rendered content again, as to get the text for the TOC entry's link.

Adds an additional dependency of striptags (MIT licensed)

Example TOC Entry, given the heading of:

```markdown
```

```javascript
{
  hashLink: 'foo',
  rawContent: '<a name="foo"></a> _Foo_',
  content: '<em>Foo</em>',
  children: []
}
```

Previously this TOC entry would be:

```javascript
{
  hashLink: 'a-name-foo-a-_foo_',
  rawContent: '<a name="foo"></a> _Foo_',
  content: '&lt;a name=&quot;foo&quot;&gt;&lt;/a&gt; <em>Foo</em>',
  children: []
}
```

closes issue #1703
2019-09-13 14:57:22 -07:00
陈杨文
3243e40ca2 feat(v2): blog tags support cjk (#1701) 2019-09-13 14:16:11 -07:00
BlackRedScarf
a16e346c81 fix: footer links margin (#1781)
* fix footer links margin

* Update main.css
2019-09-13 13:11:43 -07:00
Vincent
a5853241e1 docs: fix documented type for the cleanUrl option (#1775) 2019-09-13 12:01:23 -07:00
Felipe Guizar Diaz
b90b8bd5f1 docs: add ara framework in users (#1767) 2019-08-20 14:15:19 +07:00
burrrata
f0a7bde36d docs: add users 1Hive (#1759)
* Update users.js

added 1Hive to the Docusaurus users list

* Add files via upload

added 1hive.png bee to the img/users folder

* Update users.js

typo

* Update users.js
2019-08-17 06:10:42 +08:00
endiliey
479892ffbf chore(v2): changelog 2019-08-07 18:01:53 +07:00
Yamagishi Kazutoshi
6c4ce5722e fix(v2): do not escape html and body attributes (#1747)
* fix(v2): do not escape html and body attributes

* Update CHANGELOG-2.x.md
2019-08-07 15:56:31 +07:00
Jay Martin
7cab94a0c0 docs: add past versions to the tutorial (#1744)
* docs: add past versions to the tutorial

I changed "we" to "you" like the other sections of the tutorial.
I removed yarn from the code because `yarn version` didn't run on my Windows 10 system (see issue [1743](https://github.com/facebook/docusaurus/issues/1743)). 
I added headings for the current version, next version, and past versions.

* Update tutorial-version.md
2019-08-05 22:23:56 -07:00
Shirshendu Bhowmick
abc80e9b00 fix(v2): responsive search bar (#1741)
* Fix search bar on smaller devices

* Update packages/docusaurus-theme-search-algolia/src/theme/SearchBar/styles.css

Removed blank line

Co-Authored-By: Endi <endiliey@gmail.com>
2019-08-06 11:49:28 +07:00
Sakti Kr Chourasia
4ecdd98cc8 fix(v2): make feedback page compatible with dark mode (#1742)
* docs: make navbar less cluttered

* misc(v2): rename components (#1434)

* misc(v2): clean up work

* misc(v2): rename components

* misc(v2): rename Blog components

* refactor(v2): remove page plugin component

* chore(v2): optimize webpack config

* feat(v2): implement theme component overriding (#1435)

* feat(v2): implement component overriding

* siteDir theme overriding should work for > 1 level directory

* fallback for essential component like Loading

* rename default -> classic

* fix(v2): add missing layout alias on theme-classic plugin

* feat(v2): easier plugin theme components swizzling (#1436)

* feat(v2): easier plugin theme components override

* add context

* refactor again

* rename eject -> swizzle

* nits

* fix(v2-cli): passes the missing host option to start (#1439)

* feat(v2): Algolia search theme (#1440)

* feat(v2): Algolia search plugin

* patch PR #1440 (#1441)

* alternative implementation

* typo

* refactor noop

* rename SearchAlgolia -> SearchBar

* changes.md

* refactor(v2): move headerLinks -> themeConfig & rm dead code (#1442)

* refactor(v2): move headerLinks -> themeConfig & rm dead code

* rm -rf dead code

* chore(v2): better chunk naming

* refactor(v2): add flowtype + refactor test (#1443)

* chore(v2): add flow setup

* nits

* fix

* add flow-typed

* ignore compiled library

* fix error

* fix typing

* fix module name mapper

* setup for @docusaurus/core

* dont try remove type without @flow

* fix can't find @docusaurus/utils

* fix test

* remove obscure relative paths

* more refactoring

* add typing for server/load/theme.js

* no need to ship .flow source

* chore(v2): rm flowtype (#1444)

* chore(v2): tweak eslint config (#1445)

* chore: point website-1.x to correct version so that it can pick latest code

* feat(v2): meta description (#1447)

* feat(v2): meta description

* add description for blog as well

* fix non-descriptive text link

* remove font awesome

* switch front-matter -> gray-matter

* fix(v2): docsearch a11y issue (#1449)

* refactor(v2): blog data revamp (#1450)

* refactor(v2): blog data revamp

* fix(v2): fix incorrect blog total count

* misc: remove console.log

* feat(v2): export frontMatter as an object within MDX file (#1451)

* refactor. Don't confuse metadata & frontmatter

* export frontMatter in content itself

* nits

* nits name

* dont truncate first four lines in blog

* fix(v2): transpiling, window scroll and console error (#1452)

* chore(v2): better error message style (#1454)

* chore(v2): remove docsearch a11y workaround

* fix(v2): slugify tags

* feat(v2): blog tags (#1453)

* feat(v2): blog tags

* feat(v2): blog tags

* chore(v2): use remark-slug so that rightToc can benefit from it

* fix: right TOC should not strip special chars (#1458)

* fix: right TOC should not strip special chars

* nits

*  fix(v2): handle non existent blog, docs, pages (#1459)

* fix(v2): handle non existent blog, docs, pages

* nits

* feat(v2): list blog tags on posts (#1456)

* feat(v2): list blog tags on posts

* fix date handling on blog header

* fix console log error due to non unique key

* test(v2): test different type of sidebar item

* chore(v2): fix typo

* v2.0.0-alpha.14

* fix(v2): fix wrong dependency problem (#1460)

* v2.0.0-alpha.15

* Chore(v2): use alias instead of relative path for blogpost

* feat(v2): theme config for Footer (#1461)

* feat(v2): theme config for Footer

* fix: dont show footer if themeConfig.footer is undefined
* Import fresh docusaurus.config.js for better hot reload

* chore(v2): update dependencies (#1462)

* chore(v2): update dependencies

* nits

* v2.0.0-alpha.16

* fix(v2): fix cannot import css from node_modules in userland (#1463)

* docs: showcase user Express Validator (#1464)

* docs: sort user with alphabetical (#1465)

* chore: fix typo (#1466)

* docs: showcase user tipsi-stripe (#1423)

* docs: make it clear in the tutorial where the `docs` folder is (#1468)

* Make it clear where the `docs` folder is

It was not clear, to the beginner user—who this tutorial is for—where the `docs` folder was . The only reason I know this is because I'm a beginner user and I tried for too many minutes to find the `docs` folder inside the `website` folder. I had this assumption because the previous example is offered under the assumption that you're in the `website` folder.

Feel free to change the wording, I just want to make it clear where you should be looking, if you're new.

* Update tutorial-create-pages.md

* docs: add hint for linking dependencies time (#1470)

In this tutorial we assume that the user may or may not have used Node.js. It would follow then, based on how long it takes the "Linking dependencies" step to complete—243.61s for me—that we give them a hint that it might take a minute.

* doc: mention HTTPS approach in tutorial git clone step (#1471)

* doc: change tutorial git to suggest HTTPS

Since we're instructing the user to create a new repository, it might be a safe bet to assume that they don't have their SSH keys set up. HTTPS might be a better option in this context.

* docs: keep ssh add https

@Hongarc said, "How about keep `SSH` and add `HTTPS`." This is one way to do that.

* Update tutorial-setup.md

* docs: normalized spelling of `web server` (#1473)

* docs: clarify location of sidebars.json (#1472)

In #1468 we clarify where the `docs` folder is. 
Here, we make it clear where `sidebars.json` is.

* fix: missing cli commands (#1478)

* fix: missing cli commands

* centralize

* feat(v2): move navbar config into themeConfig (#1477)

* feat(v2): move navbar config into themeConfig

* misc: fix tests

* fix: support external url for logo

* docs(v2): CLI docs (#1476)

* WiP: CLI docs

* Tweak word choices for CLI docs

- Use the word swizzle directly
- Follow variable convention for shell

* Resolve docs discussion

* Update cli.md

* fix(v2): should be able to build even if static folder doesnt exist (#1479)

* chore: remove noWatch cli options because you cant disable watch in wds (#1480)

* docs: update StreamPipes logo (#1481)

* docs: showcase user Ax (#1483)

* docs: remove pinned for Taro (#1482)

* docs: fix typo for `docs` folder (#1484)

* docs: fix typo for `docs` folder

* docs: request change for #1484

* Update api-doc-markdown.md

* docs: add some showcase user of `facebook` (#1486)

* docs: showcase user Idb

* docs: showcase user Netconsd

* docs: showcase user Redex

* added css for feedback page contrast issue
2019-08-04 14:31:47 -07:00
Jay Martin
1c115d6ba4 docs: change the ID of the new documentation page (#1718)
* docs: add the repository to the localhost:3000 link

Fix two links on **[Create Pages](https://docusaurus.io/docs/en/next/tutorial-create-pages)**.

* docs: use the same start command on both pages

The start command in **[Scaffold the Site](https://docusaurus.io/docs/en/next/tutorial-create-new-site)** is "Run `npm start` or `yarn start.`" It will help new users to see the same start command again. A slightly different command will make new users think that something slightly different is happening.

* docs: change the ID of the new documentation page

The page ID "doc4" is already used by one of the downloaded pages, docs/exampledoc4.md, shown below: 

```
---
id: doc4
title: Other Document
---

this is another document
```

* docs: removed docusaurus-tutorial/ from the links
2019-08-04 12:42:55 -07:00
Jay Martin
8483012f36 docs: refer to Terminal and Git Bash (#1737)
I think the tutorial should tell Windows users to use Git Bash. Later in the tutorial is a command that worked in Git Bash, `publish-gh-pages`, but didn't work for me at the Windows command prompt.
2019-08-02 03:12:59 -07:00
Jay Martin
05858f0e50 docs: add an HTTPS example for publish-gh-pages (#1736)
* docs: add an HTTPS example for publish-gh-pages

I moved step 1 to step 2 so the terminal steps would be together. I added Git Bash, because `publish-gh-pages` worked for me in Git Bash but didn't work at the Windows command prompt. 

I added HTTPS to step 4 because, on my system, HTTPS worked for me but SSH didn't work. I changed <GIT_USER> to USERNAME and deleted the $ prompt, to be consistent with other examples in the tutorial.

* Update tutorial-publish-site.md
2019-08-02 02:40:25 -07:00
Endi
d6d113b1df
docs(v2): search - algolia and custom (#1734)
* docs(v2): search - algolia and custom

* revisions
2019-08-02 11:11:32 +07:00
Nick Baroni
f1415b9080 docs: change separateCSS to separateCss (#1735)
The correct property, referenced on the "Custom Pages" docs page, is `separateCss`.
2019-08-01 12:57:19 -07:00
Eran
b7f72946b0 docs: add Overwolf to users (#1728)
* Update users.js

adding our overwolf project

* Add files via upload

add the Overwolf logo file
2019-08-01 08:42:33 -07:00
Endi
ca3ae5ea96
chore: upgrade deps (#1733) 2019-08-01 19:14:12 +07:00
Sajo8
9e0d447399 docs: add TurtleCoin to users (#1730)
* Add TurtleCoin to users

* Fix missing comma
2019-07-31 01:24:41 -07:00
Wei Gao
2ebfc94ccb chore(v2): typos (#1726) 2019-07-29 19:13:59 -07:00
Jay Martin
ecc434a7fa docs: change example so USERNAME is only for GitHub (#1721)
I changed the `cd` example so it wouldn't say USERNAME like cloning example, which might mislead a new user.
2019-07-28 22:13:25 -07:00
Jay Martin
2e4663cf51 docs: revert a link to localhost:3000 (#1722)
This reverts commit e38373ac9b.
2019-07-28 22:12:22 -07:00
Wei Gao
4344b1a87d
docs(v2): deploy to netlify (#1719) 2019-07-28 16:48:24 +08:00
Jay Martin
e8cb415901 docs: fix the step numbering in "Scaffold the Site" (#1717)
Step 3 had a 2.
2019-07-27 15:03:38 -07:00
陈杨文
95ace0e4eb feat(v2): blog support date front matter (#1702)
* feat(v2): blog support date front matter

* feat(v2): blog support date front matter

* feat(v2): blog support date front matter

* feat(v2): blog support date front matter

* Update CHANGELOG-2.x.md
2019-07-27 18:03:14 +07:00
陈杨文
d17a1ea9e3 feat(v2): truncate marker as blog option (#1706)
* feat(v2): allowed more as truncate marker

* feat(v2): blog support truncateMarker option

* feat(v2): blog support truncateMarker option
2019-07-27 16:07:26 +07:00
Jay Martin
e38373ac9b docs: add the repository name to the localhost:3000 link (#1715)
Change the link from `http://localhost:3000` to `http://localhost:3000/docusaurus-tutorial/`.
2019-07-26 19:13:23 -07:00
Jay Martin
9da4cc9640 move "cd to the repository" to "Scaffold the Site" (#1713)
The folder isn't important for the command `npm install --global docusaurus-init`. 

However, it is important to run `docusaurus-init` in the repository folder. The pull request moves the step to **[Scaffold the Site](https://docusaurus.io/docs/en/next/tutorial-create-new-site#scaffold-the-site).**
2019-07-27 09:54:33 +08:00
Jay Martin
25899bfb30 add "cd to the repository" to "Scaffold the Site" (#1714)
The step "`cd` to the directory of your local repository" was moved from **[Install the Docusaurus init command](https://docusaurus.io/docs/en/next/tutorial-setup#install-the-docusaurus-init-command)**. See the [previous pull request](https://github.com/facebook/docusaurus/pull/1713).
2019-07-27 09:52:25 +08:00
Jay Martin
a867503f20 docs: rearrange the info for install and check Node.js (#1712)
The description of `npm` fits better in the opening paragraph than in a numbered step. The note about version 8 fits better in the Check section than the Install section.
2019-07-26 11:07:48 -07:00
endiliey
b5ee72a26a chore: download only enabled languages translation files 2019-07-26 23:07:04 +07:00