Skip to content

Commit

Permalink
Docs tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Kikobeats committed Jan 5, 2018
1 parent 3fc6130 commit 9dac9f6
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 17 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,31 +85,31 @@ Where the output will be something like:

Here is a list of the metadata that **metascraper** collects by default:

- **`author`** — eg. `Noah Kulwin`<br/>
- `author` — eg. **Noah Kulwin**<br/>
A human-readable representation of the author's name.

- **`date`** — eg. `2016-05-27T00:00:00.000Z`<br/>
- `date` — eg. **2016-05-27T00:00:00.000Z**<br/>
An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) representation of the date the article was published.

- **`description`** — eg. `Venture capitalists are raising money at the fastest rate...`<br/>
- `description` — eg. **Venture capitalists are raising money at the fastest rate...**<br/>
The publisher's chosen description of the article.

- **`image`** — eg. `https://assets.entrepreneur.com/content/3x2/1300/20160504155601-GettyImages-174457162.jpeg`<br/>
- `image` — eg. **https://assets.entrepreneur.com/content/3x2/1300/20160504155601-GettyImages-174457162.jpeg**<br/>
An image URL that best represents the article.

- **`lang`** — eg. `en`<br/>
- `lang` — eg. **en**<br/>
An [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) representation of the url content language.

- **`logo`** — eg. `https://entrepreneur.com/favicon180x180.png`<br/>
- `logo` — eg. **https://entrepreneur.com/favicon180x180.png**<br/>
An image URL that best represents the publisher brand.

- **`publisher`** — eg. `Fast Company`<br/>
- `publisher` — eg. **Fast Company**<br/>
A human-readable representation of the publisher's name.

- **`title`** — eg. `Meet Wall Street's New A.I. Sheriffs`<br/>
- `title` — eg. **Meet Wall Street's New A.I. Sheriffs**<br/>
The publisher's chosen title of the article.

- **`url`** — eg. `http://motherboard.vice.com/read/google-wins-trial-against-oracle-saves-9-billion`<br/>
- `url` — eg. **http://motherboard.vice.com/read/google-wins-trial-against-oracle-saves-9-billion**<br/>
The URL of the article.

## How it works
Expand Down Expand Up @@ -138,17 +138,17 @@ Rules work as fallback between them:

If you want to load more rules set that the provided by default, you need to define a configuration file via:

- A `.metascraperrc` file, written in YAML or JSON, with optional extensions: `.yaml/.yml/.json/.js`.
- A `.metascraperrc` file, written in YAML or JSON, with optional extensions: **.yaml**, **.yml**, **.json** and **.js**.
- A `metascraper.config.js` file that exports an object.
- A `"metascraper"` key in your `package.json` file.
- A **metascraper** key in your `package.json` file.

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 order of rules are loaded are important: Just the first rule that resolve the value will be applied.

### Basic Configuration

Declared an `array` of `rules`, specifying each rule as `string` name of the module to load.
Declared an **array** of **rules**, specifying each rule as **string** name of the module to load.

#### JSON

Expand Down Expand Up @@ -187,7 +187,7 @@ rules:
### Advanced Configuration
Additionally, you can pass specific configuration per module using a `object` declaration:
Additionally, you can pass specific configuration per module using a **object** declaration:
#### JSON
Expand Down
14 changes: 13 additions & 1 deletion src/css/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -613,7 +613,8 @@ body.sticky .sidebar-toggle {
}

.markdown-section p.warn {
background: var(--green2);
background: var(--green3);
color: var(--green9);
border-radius: 2px;
padding: 16px;
padding: 1rem;
Expand Down Expand Up @@ -1042,6 +1043,17 @@ body {
color: #7f8c8d;
}

.markdown-section p code,
.markdown-section li code {
color: var(--codebox-token-var-color);
border: 1px solid var(--codebox-border-color);
font-size: 0.75rem;
padding: 3px 10px;
border-radius: 3px;
white-space: nowrap;
font-weight: 600;
}

.markdown-section code {
border-radius: 2px;
color: var(--codebox-token-var-color);
Expand Down
3 changes: 2 additions & 1 deletion src/js/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ window.$docsify = {
maxLevel: 3,
executeScript: true,
auto2top: true,
ga: 'UA-108549225-3'
ga: 'UA-108549225-3',
noEmoji: true
}
2 changes: 1 addition & 1 deletion static/main.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 9dac9f6

Please sign in to comment.