Conversation
|
Deploy preview for docusaurus-2 ready! Built with commit ff6617a |
|
Deploy preview for docusaurus-preview ready! Built with commit ff6617a |
website/docs/configuration.md
Outdated
| Keeping a well-maintained `docusaurus.config.js` helps you, your collaborators, and your open source contributors be able to focus on docs while having certain fields easy to customize. | ||
|
|
||
| For reference to each of the configurable fields, you may refer to the API reference of [docusaurus.config.js](/docs/docusaurus.config.js). | ||
| For reference to each of the configurable fields, you may refer to the API reference of [docusaurus.config.js](docusaurus.config.js). |
website/docs/configuration.md
Outdated
| - [Theme configurations, plugins, and presets](#theme-plugins-and-presets-configurations) | ||
| - [Custom configurations](#custom-configurations) | ||
|
|
||
| For more details on the API, check out [the API Reference on `docusaurus.config.js`](docusaurus.config.js) |
website/docs/introduction.md
Outdated
| <img src="https://docusaurus.io/img/slash-introducing.svg" alt="Docusaurus"/> | ||
|
|
||
| Docusaurus 1 used to be a documentation site generator. In Docusaurus 2, we rebuilt it from the ground up, allowing for more customizability but preserved the best parts of Docusaurus 1 - easy to get started. Docusaurus 2 is a **performant static site generator** can be used to create most content-driven websites (e.g. Documentation, Blogs, Product Landing and Marketing Pages, etc) extremely fast. Out of the box, we have support for documentation-style and blogging websites. | ||
| Docusaurus 1 used to be a pure documentation site generator. In Docusaurus 2, we rebuilt it from the ground up, allowing for more customizability but preserved the best parts of Docusaurus 1 - easy to get started, versioned docs, and i18n. |
There was a problem hiding this comment.
lets omit this part first, just “easy to get started”. versioning and i18n is not yet done
There was a problem hiding this comment.
also i like the previous text of can be created to build blog, docs out of the box
| - ✂️ **Easy** - Hot reloading out-of-the-box, automatic route-based code and data splitting! Create new routes by creating new Markdown or JSX files | ||
| - 💥 **Single-page Application** - Client-side navigations and easily add dynamic interactivity to your website (Client-side Rendering) | ||
| - 🎯 **SEO Friendly** - `index.html` files are statically generated for every possible path (Static Rendering) | ||
| - 😌 **Painless** - Painless project setup. First class support for documentation |
There was a problem hiding this comment.
why is the comparison removed ? also i think the feature as bullet points are more appealing too.
There was a problem hiding this comment.
Yeah I think the comparison should stay. People won't need to spend the effort to figure out what the differences are.
I'm neutral about the format of features.
There was a problem hiding this comment.
with the comparison docs and features being explained like this, the docs will be too long. i hope the introduction docs itself is not too long.
There was a problem hiding this comment.
OK I will bring back the comparisons. I am not against it just that I prefer not to compare in a way that says how others don't fit. So I'll rephrase part of those.
There was a problem hiding this comment.
yup at least keep the comparisons.
There was a problem hiding this comment.
I prefer not to compare in a way that says how others don't fit.
Our intention is to state facts and what each tool is good for. The intention is not to criticize. As a user I'll appreciate fair and accurate comparisons that saves me time from doing it myself.
I'll rephrase part of those
Yes please 😄
|
Document #1581
2019年6月7日 23:59 +0800、Yangshun Tay <[email protected]>のメール:
… @yangshun commented on this pull request.
In website/docs/introduction.md:
>
-- ⚛️ **Built using React** - Extend or customize with React
-- 📦 **Uses webpack** - Build an optimized bundle and use any CSS-in-JS solution you like
-- ⚡️ **Lightning Fast** - Link prefetching, instant navigation and page views
-- ✂️ **Easy** - Hot reloading out-of-the-box, automatic route-based code and data splitting! Create new routes by creating new Markdown or JSX files
-- 💥 **Single-page Application** - Client-side navigations and easily add dynamic interactivity to your website (Client-side Rendering)
-- 🎯 **SEO Friendly** - `index.html` files are statically generated for every possible path (Static Rendering)
-- 😌 **Painless** - Painless project setup. First class support for documentation
> I prefer not to compare in a way that says how others don't fit.
Our intention is to state facts and what each tool is good for. The intention is not to criticize. As a user I'll appreciate fair and accurate comparisons that saves me time from doing it myself.
> I'll rephrase part of those
Yes please 😄
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub, or mute the thread.
|
|
Closing this in favor of PRs for individual pieces. |
5 participants
Motivation
Opening this PR for review and discussion on work in progress docs. I will brief my thoughts in follow up comments. And I'll PR complete pieces incrementally.
Have you read the Contributing Guidelines on pull requests?
Yes.
Test Plan
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)
NA
Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)