Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(v2) themes #1645

Merged
merged 13 commits into from Jul 26, 2019

Conversation

@wgao19
Copy link
Collaborator

commented Jul 9, 2019

Motivation

Add docs for themes

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

NA

Related PRs

#1640

@wgao19 wgao19 requested review from endiliey and yangshun as code owners Jul 9, 2019

@wgao19 wgao19 self-assigned this Jul 9, 2019

@docusaurus-bot

This comment has been minimized.

Copy link
Collaborator

commented Jul 9, 2019

Deploy preview for docusaurus-2 ready!

Built with commit 92504a0

https://deploy-preview-1645--docusaurus-2.netlify.com

@docusaurus-bot

This comment has been minimized.

Copy link
Collaborator

commented Jul 9, 2019

Deploy preview for docusaurus-preview ready!

Built with commit 92504a0

https://deploy-preview-1645--docusaurus-preview.netlify.com

@wgao19

This comment has been minimized.

Copy link
Collaborator Author

commented Jul 22, 2019

exemplify swizzling heading #1687

@wgao19 wgao19 force-pushed the wgao19/docs-themes branch from f352ecb to a234f33 Jul 23, 2019

@wgao19

This comment has been minimized.

Copy link
Collaborator Author

commented Jul 24, 2019

Hey @endiliey @yangshun these docs are ready for a round of review. Please let me know what you think and places to improve.

There are quite some changes around how plugins and themes docs are organized. Please make sure you browse around these sections on the preview sites to get a feeling that they make sense:

  • Guides: Using Plugins
  • Guides: Using Themes
  • Advanced Guides: Themes

I've also combined the API docs for themes and plugins to a file called Lifecycle APIs because themes and plugins share the same lifecycle methods.

@endiliey
Copy link
Collaborator

left a comment

some suggestions and typo

will rereview again

'@docusaurus/plugin-content-pages',
[
// Plugin with options
'@docusaurus/plugin-content-blog',

This comment has been minimized.

Copy link
@endiliey

endiliey Jul 24, 2019

Collaborator

since passing options is mentioned in the next section, lets simplify this part

A plugin is an npm package, so you install them like other npm packages using npm.

```bash
yarn add docusaurus-plugin-name

This comment has been minimized.

Copy link
@endiliey

endiliey Jul 24, 2019

Collaborator

use npm

As an example, to swizzle the `<Footer />` component in `@docusaurus/theme-classic` for your site, run:

```shell
$ yarn swizzle @docusaurus/theme-classic

This comment has been minimized.

Copy link
@endiliey

endiliey Jul 24, 2019

Collaborator

typo here.

npm swizzle @docusaurus/theme-classic Footer

- [@docusaurus/plugin-content-pages](https://github.com/facebook/docusaurus/tree/master/packages/docusaurus-plugin-content-pages)
- [@docusaurus/plugin-google-analytics](https://github.com/facebook/docusaurus/tree/master/packages/docusaurus-plugin-google-analytics)
- [@docusaurus/plugin-google-gtag](https://github.com/facebook/docusaurus/tree/master/packages/docusaurus-plugin-google-gtag)
- [@docusaurus/plugin-sitemap](https://github.com/facebook/docusaurus/tree/master/packages/docusaurus-plugin-sitemap)

This comment has been minimized.

Copy link
@endiliey

endiliey Jul 24, 2019

Collaborator

mention plugin ideal image too

Themes provide the consistent components for your doc sites.

<!-- TODO: WIP intro -->

This comment has been minimized.

Copy link
@endiliey

endiliey Jul 24, 2019

Collaborator

i find it hard to understand themes without reading advanced guide-themes. I think we should try giving user understanding of themes first before teaching them how to use it. Not really sure whats the best approach

@wgao19

This comment has been minimized.

Copy link
Collaborator Author

commented Jul 24, 2019

@endiliey updated

@endiliey

This comment has been minimized.

Copy link
Collaborator

commented on packages/docusaurus-theme-classic/README.md in c063d96 Jul 25, 2019

lets just link it to the theme folder so that we dont need to update the readme everytime

or omit it ?

@wgao19

This comment has been minimized.

Copy link
Collaborator Author

commented Jul 26, 2019

@endiliey removed it and replaced with the theme folder

@wgao19 wgao19 changed the title WiP: docs(v2) themes docs(v2) themes Jul 26, 2019

@endiliey endiliey merged commit f4f4584 into master Jul 26, 2019

4 checks passed

ci/circleci: lint-prettier Your tests passed on CircleCI!
Details
ci/circleci: tests Your tests passed on CircleCI!
Details
deploy/netlify Deploy preview ready!
Details
netlify/docusaurus-2/deploy-preview Deploy preview ready!
Details
@endiliey

This comment has been minimized.

Copy link
Collaborator

commented Jul 26, 2019

we can always tweak. merged

@wgao19 wgao19 referenced this pull request Jul 26, 2019
12 of 19 tasks complete

@endiliey endiliey deleted the wgao19/docs-themes branch Aug 6, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.