3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-03 16:59:06 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs(v2): move the quotes to remark admonitions (#2313)

Browse source 
* docs(v2): move the quotes to remark admonitions

* Delete package-lock.json

Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
This commit is contained in:
Zhenchao Cai 2020-02-23 04:11:37 -06:00 • committed by GitHub
parent d06ab640ff
commit b25eb5dd36
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 91 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

6
website/docs/design-principles.md
View file

@ -3,7 +3,11 @@ id: design-principles
title: Design Principles
---
> :warning: _This section is a work in progress._
:::caution
_This section is a work in progress._
:::
- **Little to learn** - Docusaurus should be easy to learn and use as the API is quite small. Most things will still be achievable by users, even if it takes them more code and more time to write. Not having abstractions is better than having the wrong abstractions, and we don't want users to have to hack around the wrong abstractions. Mandatory talk - [Minimal API Surface Area](https://www.youtube.com/watch?v=4anAwXYqLG8).
- **Intuitive** - Users will not feel overwhelmed when looking at the project directory of a Docusaurus project or adding new features. It should look intuitive and easy to build on top of, using approaches they are familiar with.