Move all docs to website by azz · Pull Request #3139 · prettier/prettier

azz · 2017-11-03T08:55:30Z

Moves all documentation to the website.

Includes Rationale.md
Move contents and delete /editors directory
Breaks up Usage into many pages. Technically a breaking change for /usage.html URLs.

Closes #2825
Supersedes #3116

Closes #3028
Closes #3138

ikatyang · 2017-11-03T11:03:54Z

docs/api.md

+
+## `prettier.format(source [, options])`
+
+`format` is used to format text using Prettier. [Options](#options) may be provided to override the defaults.


[Options](./options.html)

ikatyang · 2017-11-03T11:04:46Z

docs/api.md

+searching from the current directory).
+Or you can pass directly the path of the config file as `options.config` if you don't wish to search for it.
+A promise is returned which will resolve to:
+* An options object, providing a [config file](#configuration-file) was found.


[config file](./configuration.html)

ikatyang · 2017-11-03T11:04:58Z

docs/cli.md

+---
+
+Run Prettier through the CLI with this script. Run it without any
+arguments to see the [options](#options).


[options](./options.html)

ikatyang · 2017-11-03T11:06:02Z

docs/cli.md

+## `--find-config-path` and `--config`
+
+If you are repeatedly formatting individual files with `prettier`, you will incur a small performance cost
+when prettier attempts to look up a [configuration file](#configuration-file). In order to skip this, you may


[configuration file](./configuration.html)

ikatyang · 2017-11-03T11:06:40Z

docs/configuration.md

+The configuration file will be resolved starting from the location of the file being formatted,
+and searching up the file tree until a config file is (or isn't) found.
+
+The options to the configuration file are the same the [API options](#options).


[API options](./options.html)

ikatyang · 2017-11-03T11:07:03Z

docs/configuration.md

+}
+```
+
+For more information on how to use the CLI to locate a file, see the [CLI](#cli) section.


[CLI](./cli.html)

ikatyang · 2017-11-03T11:07:49Z

docs/language-support.md

+[Babylon](https://github.com/babel/babylon) parser with all language
+features enabled, but you can also use the
+[Flow](https://github.com/facebook/flow) parser with the
+`parser` API or `--parser` CLI [option](#options).


[option](./options.html)

ikatyang · 2017-11-03T11:10:09Z

docs/options.md

+ * [`json`](https://github.com/babel/babylon/tree/f09eb3200f57ea94d51c2a5b1facf2149fb406bf#babylonparseexpressioncode-options) _Since v1.5.0_
 * [`graphql`](https://github.com/graphql/graphql-js/tree/master/src/language) _Since v1.5.0_

 [Custom parsers](#custom-parser-api) are also supported.  _Since v1.5.0_


[Custom parsers](./api.html#custom-parser-api)

ikatyang · 2017-11-03T11:11:41Z

docs/index.md

+
+
+[empty lines]:/docs/en/rationale.html#empty-lines
+[multi-line objects]:/docs/en/rationale.html#multi-line-objects


Would be better to use relative path?

ikatyang · 2017-11-03T11:13:25Z

README.md

 [![NPM version](https://img.shields.io/npm/v/prettier.svg)](https://www.npmjs.com/package/prettier)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](#badge)

-Prettier is an opinionated code formatter with support for:


Prettier is an opinionated code formatter

A simple description here would be better I think.

ikatyang · 2017-11-03T11:15:02Z

Footer needs to be updated as well, especially Usage.

prettier/website/core/Footer.js

Lines 40 to 44 in e436ada

    
           <h5>Docs</h5> 
        
           <a href={this.url("/why-prettier.html")}>Why Prettier?</a> 
        
           <a href={this.url("/usage.html")}>Usage</a> 
        
           <a href={this.url("/options.html")}>Options</a> 
        
           <a href={this.url("/editors.html")}>Editor Integeration</a>

azz · 2017-11-03T11:42:39Z

Thanks for the review! Should have marked as wip - I knew about the links needing to be changed.

duailibe · 2017-11-03T12:12:13Z

README.md

-
-Prettier enforces a consistent code **style** (i.e. code formatting that won't affect the AST) across your entire codebase because it disregards the original styling[\*](#styling-footnote) by parsing it away and re-printing the parsed AST with its own rules that take the maximum line length
-into account, wrapping code when necessary.
-


I'd keep this part here (not the title "What does prettier do?")

Prettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing the parsed AST with its own rules that take the maximum line length into account, wrapping code when necessary. For example, take the following code:  You can try it on our interactive REPL: http://prettier.io/playground

I’d still include the example to make it more clear what prettier does.

Trying to avoid too much copy-pasting. We're doing this to remove the need to sync the docs.

However, I think it would be a great idea to write a different, more concise summary of Prettier in the README, with a basic example.

Basically like this https://github.com/babel/babel#intro

Yeah I'm just saying an example would be very good here, I don't really care which one :-)

I suggested keeping the one there just for the sake of simplicity

ikatyang · 2017-11-03T13:05:30Z

README.md

-[![Codecov](https://img.shields.io/codecov/c/github/prettier/prettier.svg)](https://codecov.io/gh/prettier/prettier)
-[![NPM version](https://img.shields.io/npm/v/prettier.svg)](https://www.npmjs.com/package/prettier)
-[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](#badge)
+![](https://cloud.githubusercontent.com/assets/311752/24736977/385d81c8-1a40-11e7-8adc-c4c879ba6c31.png)


![Prettier Banner](https://raw.githubusercontent.com/prettier/prettier-logo/master/images/prettier-banner-dark.png)?

ikatyang · 2017-11-03T13:10:42Z

docs/options.md

 * [`graphql`](https://github.com/graphql/graphql-js/tree/master/src/language) _Since v1.5.0_

-[Custom parsers](#custom-parser-api) are also supported.  _Since v1.5.0_
+[Custom parsers](./custom-parser-api.html) are also supported.  _Since v1.5.0_


This one is a special case: [Custom parsers](./api.html#custom-parser-api)

azz · 2017-11-04T04:20:57Z

OK I think this is good to go, any final comments?

ikatyang · 2017-11-04T16:07:17Z

Just realized we forgot to mention the markdown support on homepage: azz#1

existentialism

👍

ikatyang · 2017-11-05T05:38:08Z

docs/ignore.md

+
+## Markdown
+
+```


```markdown ( ```md will cause yarn build failed)

Fixed. I had to remove vim from a bunch of places for the same reason. Should investigate because vim is supported by Prism.

It seems the prism in docusaurus is outdated, I didn't see any vim in website/node_modules/docusaurus/lib/core/Prism.js, and the new [email protected] seems replaced it with highlight.js.

azz · 2017-11-05T06:00:12Z

Not sure why codecov is saying coverage decreased. Didn't touch any source code.

ikatyang · 2017-11-05T11:53:12Z

docs/cli.md

+---
+
+Run Prettier through the CLI with this script. Run it without any
+arguments to see the [options](./options.html).


https://docusaurus.io/docs/en/doc-markdown.html#linking-other-documents

This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct html links when they get rendered.

[options](./options.html) -> [options](options.md)

Ooh neat. I'll check if it works with the version we're using.

I've tested, it works. 👍

azz added 7 commits November 3, 2017 19:51

Sync README -> docs/options.md

351279a

Sync README -> docs/*.md

0331896

Misc fixups

6cfc355

Remove markdown-toc

90b91bc

Remove insert-pragma from ToC

a0592f6

Never again!

d5f6342

Move all docs to ./docs

28a0fc6

azz mentioned this pull request Nov 3, 2017

Sync docs from README.md to docs/*.md #3116

Closed

Remove yarn toc

db8e7b7

ikatyang reviewed Nov 3, 2017

View reviewed changes

azz added 2 commits November 3, 2017 23:02

Fix inter-doc links

6aa82b5

Fix links in footer

a7447e6

duailibe reviewed Nov 3, 2017

View reviewed changes

azz added 6 commits November 3, 2017 23:22

Clean up README.md

6b3315c

Add basic description to README.md

dcccc03

Use flat badges

b09d33a

Move editor guides to website

b3dd728

Improve prettier-ignore docs

9650fd2

Fixup bad find/replace

bdf35e6

ikatyang reviewed Nov 3, 2017

View reviewed changes

azz added 3 commits November 4, 2017 00:12

Add JSON to README

a9d2378

Fix custom parser API link

fcf9e6d

Fixup GitHub centering, add downloads badge

940c865

azz force-pushed the docs-to-website branch from 5bdfb6b to 52cb134 Compare November 3, 2017 14:07

Add 1.8 docs

52cb134

azz mentioned this pull request Nov 4, 2017

1.8 Release #3117

Closed

9 tasks

ikatyang approved these changes Nov 4, 2017

View reviewed changes

ikatyang mentioned this pull request Nov 4, 2017

docs(website): mention markdown on homepage azz/prettier#1

Merged

existentialism approved these changes Nov 4, 2017

View reviewed changes

ikatyang and others added 3 commits November 5, 2017 11:24

docs(website): mention markdown on homepage (#1)

3118aa2

Add intro

bfdeb71

Add watching-files.md

b000759

ikatyang reviewed Nov 5, 2017

View reviewed changes

Fix markdown syntax highlighting

762d30b

ikatyang reviewed Nov 5, 2017

View reviewed changes

azz added 3 commits November 5, 2017 23:06

Switch back to .md links

f33b73d

Merge branch 'master' into docs-to-website

368ad00

Merge branch 'master' into docs-to-website

8d33336

azz merged commit 71a5533 into prettier:master Nov 7, 2017

azz deleted the docs-to-website branch November 7, 2017 03:39

duailibe mentioned this pull request Dec 10, 2017

The autogenerated toc in the main README.md should comply with the new markdown parser #3031

Closed

lock bot added the locked-due-to-inactivity Please open a new issue and fill out the template instead of commenting. label Jan 19, 2019

lock bot locked as resolved and limited conversation to collaborators Jan 19, 2019


		## `prettier.format(source [, options])`

		`format` is used to format text using Prettier. [Options](#options) may be provided to override the defaults.



		[empty lines]:/docs/en/rationale.html#empty-lines
		[multi-line objects]:/docs/en/rationale.html#multi-line-objects


		Prettier enforces a consistent code style (i.e. code formatting that won't affect the AST) across your entire codebase because it disregards the original styling[\*](#styling-footnote) by parsing it away and re-printing the parsed AST with its own rules that take the maximum line length
		into account, wrapping code when necessary.


		## Markdown

		```

Uh oh!

Conversation

azz commented Nov 3, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ikatyang commented Nov 3, 2017

Uh oh!

azz commented Nov 3, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

azz commented Nov 4, 2017

Uh oh!

ikatyang commented Nov 4, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

existentialism left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ikatyang Nov 5, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

azz commented Nov 5, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

azz commented Nov 3, 2017 •

edited

Loading

ikatyang commented Nov 4, 2017 •

edited

Loading

ikatyang Nov 5, 2017 •

edited

Loading