Skip to content

Commit

Permalink
expand all inline links
Browse files Browse the repository at this point in the history
  • Loading branch information
balupton committed Mar 22, 2017
1 parent f902a63 commit ee42d6e
Show file tree
Hide file tree
Showing 16 changed files with 74 additions and 74 deletions.
22 changes: 11 additions & 11 deletions 01-start/00-intro.html.md.eco
Expand Up @@ -24,27 +24,27 @@ comparisonTable: """
Plugin and extension system
**Yes**
No
**[Yes](/docs/extend)**
**[Yes](https://docpad.org/docs/extend)**

Asset pipeline
No
Implicit & bundled
**[Explicit & extendable](/docs/overview#the-render-directory)**
**[Explicit & extendable](https://docpad.org/docs/overview#the-render-directory)**

Markup languages (markdown, rst, etc.)
No
1 bundled
**Via [plugins](/docs/plugins#renderers)**
**Via [plugins](https://docpad.org/docs/plugins#renderers)**

Pre-processors (sass, less, etc.)
No
No
**Via [plugins](/docs/plugins#renderers)**
**Via [plugins](https://docpad.org/docs/plugins#renderers)**

Template engines (eco, jade, etc.)
No
1 bundled
**Via [plugins](/docs/plugins#renderers)**
**Via [plugins](https://docpad.org/docs/plugins#renderers)**

Database querying
**Yes**
Expand All @@ -64,12 +64,12 @@ comparisonTable: """
Re-render each request
Always
No
**Via [`dynamic` field](/docs/meta-data#dynamic)**
**Via [`dynamic` field](https://docpad.org/docs/meta-data#dynamic)**

Extend the webserver
**Yes**
No
**Via [events](/docs/events#serverextend) and [API](/docs/api)**
**Via [events](https://docpad.org/docs/events#serverextend) and [API](https://docpad.org/docs/api)**

Watching
**N/A**
Expand Down Expand Up @@ -104,12 +104,12 @@ comparisonTable: """
Import pages from external database (MongoDB, MySQL, etc.)
**Yes**
No
**Via [plugins](/docs/plugins#admin-interfaces)**
**Via [plugins](https://docpad.org/docs/plugins#admin-interfaces)**

Import pages from external services (Tumblr, Dropbox, GitHub, etc.)
No
No
**Via [plugins](/docs/plugins#admin-interfaces)**
**Via [plugins](https://docpad.org/docs/plugins#admin-interfaces)**

Import data from external services (Atom, XML, JSON, etc.)
No
Expand All @@ -119,7 +119,7 @@ comparisonTable: """
WYSIWYG editors
**Yes**
No
**Via [plugins](/docs/plugins#admin-interfaces)**
**Via [plugins](https://docpad.org/docs/plugins#admin-interfaces)**
""".split('\n\n').map((i) -> '| '+i.split('\n').join(' | ')+' |').join('\n')
```

Expand Down Expand Up @@ -175,7 +175,7 @@ On the other hand, let's compare that with DocPad, which is:
- **Robust**
- Use your desktop counterparts to edit content naturally (Sublime Text, Vim, Byword, etc.)
- Abstraction friendly; code the way you want, how you want
- Use whatever language, pre-processor, markup, templating engine you want - it's all covered via our [opt-in plugins](/docs/plugins) (and if it isn't, it's very easy to add)
- Use whatever language, pre-processor, markup, templating engine you want - it's all covered via our [opt-in plugins](https://docpad.org/docs/plugins) (and if it isn't, it's very easy to add)

Besides this, thanks to the opt-in modular philosophy of Node, we benefit from all the innovations of the community as a whole, including:

Expand Down
6 changes: 3 additions & 3 deletions 01-start/01-install.html.md.eco
@@ -1,7 +1,7 @@
```
title: "Install"
```
_If you are upgrading from one major version to another (e.g. DocPad v5 to DocPad v6), be sure to checkout our [Upgrade Guide](/docs/upgrade) for information relating to backwards compatibility breaks._
_If you are upgrading from one major version to another (e.g. DocPad v5 to DocPad v6), be sure to checkout our [Upgrade Guide](https://docpad.org/docs/upgrade) for information relating to backwards compatibility breaks._

1. [Install Node & Other Dependencies](https://learn.bevry.me/node/install)

Expand All @@ -20,6 +20,6 @@ _If you are upgrading from one major version to another (e.g. DocPad v5 to DocPa

1. **When upgrading:** in addition to the above, run `docpad update` inside your project directory to ensure that your local installation of DocPad and its plugins are updated to their latest compatible versions,

1. When you run DocPad for the first time using `docpad run`, you'll be asked if you agree with the [Terms of Service](/tos). The TOS is necessary due to our extreme transparency and respect for our users. We want to make sure that our respect for your information is guaranteed, and that it will never be abused. Without a TOS, expectations can become misaligned and problems could occur. We would never want that. We want our users to know the exact measures we take in order to best serve you (collecting statistics, running newsletters, expanding the business, etc.), just so you know how highly we regard you over ourselves. If you run into trouble with the ToS, check [this FAQ entry](/docs/faq#cannot-get-past-accepting-the-terms-of-service).
1. When you run DocPad for the first time using `docpad run`, you'll be asked if you agree with the [Terms of Service](/tos). The TOS is necessary due to our extreme transparency and respect for our users. We want to make sure that our respect for your information is guaranteed, and that it will never be abused. Without a TOS, expectations can become misaligned and problems could occur. We would never want that. We want our users to know the exact measures we take in order to best serve you (collecting statistics, running newsletters, expanding the business, etc.), just so you know how highly we regard you over ourselves. If you run into trouble with the ToS, check [this FAQ entry](https://docpad.org/docs/faq#cannot-get-past-accepting-the-terms-of-service).

_If you get any errors, try running DocPad anyway (most installation errors are non fatal and just for debugging purposes). If you do get a fatal error then refer to our [Troubleshooting Guide](/docs/troubleshoot) as there's probably already a working solution. :-)_
_If you get any errors, try running DocPad anyway (most installation errors are non fatal and just for debugging purposes). If you do get a fatal error then refer to our [Troubleshooting Guide](https://docpad.org/docs/troubleshoot) as there's probably already a working solution. :-)_
6 changes: 3 additions & 3 deletions 01-start/02-overview.html.md
Expand Up @@ -35,7 +35,7 @@ The `render` and `documents` directories, and the `static` and `files` directori

Layouts work in a very similar way to files in `render`, in that they are rendered and they support meta data. Unlike the files in `render`, however, they are not output to the `out` directory, as they only exist to wrap files in `render` and other layouts within themselves. Layouts work in a nested fashion, with the desired layout being defined by the `layout` meta data property within the child layout/document.

Layouts should include child content, which is done using the `content` [template data](/docs/template-data#standard-template-data) variable. For instance, the code to use the content variable with the [Eco](https://github.com/sstephenson/eco/) templating engine via the [Eco DocPad plugin](https://github.com/docpad/docpad-plugin-eco) would be `<%- @content %>`.
Layouts should include child content, which is done using the `content` [template data](https://docpad.org/docs/template-data#standard-template-data) variable. For instance, the code to use the content variable with the [Eco](https://github.com/sstephenson/eco/) templating engine via the [Eco DocPad plugin](https://github.com/docpad/docpad-plugin-eco) would be `<%- @content %>`.


#### The `render` Directory
Expand All @@ -44,7 +44,7 @@ These are files that we would like to render. Rendering occurs extension to exte

The reason we do not support direct rendering from `script.coffee` to `script.js` is that such a convention would eliminate the ability to combine extension renderings, also because ambiguity between extensions that can be rendered in multiple ways. For instance the `coffee` extension could be rendered using [CoffeeScript](http://coffeescript.org) to JavaScript or using [CoffeeKup](http://coffeekup.org) to HTML. However, if you really want to use just a single extension, such a thing is supported by the `renderSingleExtensions` meta property.

The other important aspect of files in `render` it that they support meta data. Meta data goes at the top of a document and defines information about that particular document. For instance, its title, date and layout are good examples. Meta data is not restricted to particular values, meaning you can define whatever meta data you want against a document. There are some special meta data properties, however, that perform certain functions (e.g., `layout` is used to specify the layout that should be used to wrap the document). You can find the complete listing of special meta data properties on the [Meta Data page](/docs/meta-data).
The other important aspect of files in `render` it that they support meta data. Meta data goes at the top of a document and defines information about that particular document. For instance, its title, date and layout are good examples. Meta data is not restricted to particular values, meaning you can define whatever meta data you want against a document. There are some special meta data properties, however, that perform certain functions (e.g., `layout` is used to specify the layout that should be used to wrap the document). You can find the complete listing of special meta data properties on the [Meta Data page](https://docpad.org/docs/meta-data).


#### The `static` Directory
Expand All @@ -54,7 +54,7 @@ Files in this folder, like those in `render`, are output to the `out` directory.

### The `docpad.coffee` file

The `docpad.coffee` file can have several different extensions. It defines DocPad's settings. You can find full documentation on the [Configuration docs page](/docs/config).
The `docpad.coffee` file can have several different extensions. It defines DocPad's settings. You can find full documentation on the [Configuration docs page](https://docpad.org/docs/config).


### The `package.json` File
Expand Down

0 comments on commit ee42d6e

Please sign in to comment.