From f4f441f175d775e0216b0a4f4720a8e2ec653b52 Mon Sep 17 00:00:00 2001 From: Maxime Thirouin Date: Tue, 15 Nov 2016 16:22:47 +0100 Subject: [PATCH] Docs: some grammar and language updates (thanks @ben-eb) [skip ci] --- CHANGELOG.md | 2 +- docs/content/docs/getting-started.md | 4 ++-- docs/content/docs/setup.md | 4 ++-- docs/content/docs/usage/plugins.md | 6 +++--- docs/content/index.md | 4 ++-- themes/phenomic-theme-base/content/about.md | 5 ++--- themes/phenomic-theme-base/content/index.md | 13 +++++++------ 7 files changed, 19 insertions(+), 19 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 147f27a0e..69a874d03 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -810,7 +810,7 @@ _You will need at least ``react-router@^2.3.0``._ **Don't be afraid by the length of this release notes. It's for the better.** Most noticeable change occurs in the ``scripts`` folder. -It might be a good idea is to take a look to the new folder of the default +It might be a good idea is to take a look at the new folder of the default boilerplate: - There is now just 2 files: ``phenomic.browser.js`` (client runtime) and diff --git a/docs/content/docs/getting-started.md b/docs/content/docs/getting-started.md index d0bdf6c83..d97cc33ec 100644 --- a/docs/content/docs/getting-started.md +++ b/docs/content/docs/getting-started.md @@ -107,7 +107,7 @@ If you need to start with React you might want to check the following resources: - [reactforbeginners.com](https://ReactForBeginners.com/friend/MOOX) - [Build your first real world React.js application](http://academy.plot.ly/#react) -You might also take a look to +You might also take a look at [react-howto](https://github.com/petehunt/react-howto) to understand what you might need to learn and what you don't. Also learning ES6/ES2015+ is recommended. @@ -338,5 +338,5 @@ If you really want to add Sass or LESS for you styles you can replace in your πŸ€— Now have fun! -**Take a look to the [rest of the documentation](../usage/) where you will +**Take a look at the [rest of the documentation](../usage/) where you will find more details on everything about Phenomic and how to use it**. diff --git a/docs/content/docs/setup.md b/docs/content/docs/setup.md index 209794588..758cb1e2b 100644 --- a/docs/content/docs/setup.md +++ b/docs/content/docs/setup.md @@ -80,7 +80,7 @@ yarn add phenomic && .\node_modules\.bin\phenomic setup yarn install && yarn start ``` -πŸš€ **When you get the hello world, it's time to take a look to our +πŸš€ **When you get the hello world, it's time to take a look at our [Getting Started](../getting-started/) page and to [start hacking!](../usage/).** @@ -201,5 +201,5 @@ your development server in your favorite browser). --- -πŸš€ **When you get the hello world, it's time to take a look to our +πŸš€ **When you get the hello world, it's time to take a look at our [Getting Started](../getting-started/) page and to [start hacking!](../usage/).** diff --git a/docs/content/docs/usage/plugins.md b/docs/content/docs/usage/plugins.md index dd7593a16..498b7609a 100644 --- a/docs/content/docs/usage/plugins.md +++ b/docs/content/docs/usage/plugins.md @@ -129,7 +129,7 @@ Phenomic provides the following presets: πŸ›  This preset is kind of the phenomic default requirement. Use it if you want to use classic files with a front-matter and any text format. -**Feel free to take a look to markdown preset to implement your own engine!** +**Feel free to take a look at markdown preset to implement your own engine!** ### ``phenomic/lib/loader-preset-markdown`` @@ -181,7 +181,7 @@ import { phenomicLoader } from "phenomic" // doYourThing() can be any transformation you want. // Per previous plugins, ``body`` will contain the raw input // passed to the loader, with the front-matter removed. - // Feel free to take a look to the plugins source before, + // Feel free to take a look at the plugins source before, // it's very short ! // https://github.com/MoOx/phenomic/blob/master/src/ } @@ -283,6 +283,6 @@ const transformMdBodyPropertyToHTML = ({ result }) => { } ``` -⚠️ If you want to see some examples for plugins, take a look to +⚠️ If you want to see some examples for plugins, take a look at https://github.com/MoOx/phenomic/blob/master/src/ diff --git a/docs/content/index.md b/docs/content/index.md index f2c7ef1d3..cda8b40f5 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -36,7 +36,7 @@ the minimal amount of data for each new page** (a single file that only contains your page data).
- Take a look to websites using Phenomic πŸ‘€ + Take a look at websites using Phenomic πŸ‘€
## Setup a website in a flash @@ -65,7 +65,7 @@ It also contains commented pieces of code that allows you to quickly customize it to fit your needs.
- Take a look to the base theme demo πŸ‘€ + Take a look at the base theme demo πŸ‘€
--- diff --git a/themes/phenomic-theme-base/content/about.md b/themes/phenomic-theme-base/content/about.md index 1e14e9f16..6f428b676 100644 --- a/themes/phenomic-theme-base/content/about.md +++ b/themes/phenomic-theme-base/content/about.md @@ -12,14 +12,13 @@ cta: You are currently viewing Phenomic base theme. For now [Phenomic does not provide a native way to extend themes](https://github.com/MoOx/phenomic/issues/508) but since it's based on -React and use a component approach, it's pretty easy to make your own collection -of layouts and components and reuse those. +React and uses a component approach, it's pretty easy to make your own reusable collection of layouts and components. --- This website is made with [Phenomic](https://phenomic.io/). -If you are curious about it, you can take a look to +If you are curious about it, you can take a look at [existing websites that use Phenomic](https://phenomic.io/showcase/), some projects share their source code! diff --git a/themes/phenomic-theme-base/content/index.md b/themes/phenomic-theme-base/content/index.md index c47254042..5a5444f2c 100644 --- a/themes/phenomic-theme-base/content/index.md +++ b/themes/phenomic-theme-base/content/index.md @@ -15,7 +15,7 @@ Hi there. Before having fun with Phenomic, be sure to read the documentationΒ : * [Usage & APIs](https://phenomic.io/docs/usage/) * [FAQ](https://phenomic.io/docs/faq/) -Also take a look to +Also take a look at [existing websites that use Phenomic](https://phenomic.io/showcase/), some projects share their source code! @@ -30,12 +30,13 @@ some projects share their source code! --- -You may want to take a look to the [404.html](/404.html) and tweak the render. +You may want to take a look at the [404.html](/404.html) and tweak the render. -If you want to adjust page layouts, directly adjust them in ``src/layouts/``. -If you want to adjust small parts like header, footer, buttons, etc, you will -find those in ``src/components/``. -For colors and common CSS variables, you will find stuff to adjust in ``postcss.plugins.js``. +If you need to make adjustments, you can directly alter page layouts in +``src/layouts/``; +small things like the header, footer, buttons and so on can be changed in +``src/components/``; +and for colors and common CSS variables, you can modify ``postcss.config.js``. _You feel like the base theme is not enough or you just saw something wrong?_ [Please help us make Phenomic better!](https://phenomic.io/contributing/)