Skip to content

Commit bce5646

Browse files
committed
make sure style guide docs make sense whether we are on documentjs.com or documentcss.com
1 parent f31a81d commit bce5646

15 files changed

+47
-35
lines changed

docs/livestyleguide/guides/adding.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ This guide will:
99
* Give a designer-friendly explanation of what DocumentJS does
1010
* Make sure you have everything you need installed
1111
* Help you configure DocumentJS to add a Live Style Guide
12-
* Explain how to use [tags](/docs/documentjs.tags.html) to write your Live Style Guide
12+
* Explain how to use [tags](http://documentjs.com/docs/documentjs.tags.html) to write your Live Style Guide
1313

1414
You should start elsewhere if:
1515

1616
* You want to [create a Live Style Guide on a project that doesn't already use DocumentJS](/docs/lsg-quickstart.html)
17-
* You still need to set up DocumentJS for [API documentation](/docs/index.html)
17+
* You still need to set up DocumentJS for [API documentation](http://documentjs.com/docs/index.html)
1818
* You're just [trying to kill time](https://www.youtube.com/watch?v=6EneCIPJsog)
1919

2020
First, [a brief disclaimer](/docs/lsg-adding-disclaimer.html)

docs/livestyleguide/guides/adding/disclaimer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The [Standalone Guide](/docs/lsg-quickstart.html) is likely more precise when it
1010
There are a few ways to compensate for the ways this guide may differ from your specific project setup:
1111

1212
* Go through this guide with a developer who understands how the API Documentation is set up in your project
13-
* Ask questions on [Gitter](https://gitter.im/bitovi/documentjs)
14-
* Open [an issue](https://github.com/bitovi/documentjs/issues/new) to let us know when something isn't clear
13+
* Ask questions on [Gitter](https://gitter.im/bitovi/documentcss)
14+
* Open [an issue](https://github.com/bitovi/documentcss/issues/new) to let us know when something isn't clear
1515

1616
[Next Page](/docs/lsg-adding-designers.html)

docs/livestyleguide/guides/adding/fileorganization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ project/
3737
<!-- Automatically generated directory -->
3838
```
3939

40-
[Next Page](/docs/lsg-adding-writing.html)
40+
[Next Page](/docs/lsg-adding-next-steps.html)

docs/livestyleguide/guides/adding/fordesigners.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ If you're working on a project that is already using DocumentJS, it is being use
88
* Include demos to display examples alongside sample markup
99
* Organize pages into navigation groups like "Elements," "Themes," and "Components"
1010

11-
To see an example of this in action, check out the DocumentJS.com [Live Style Guide](/examples/styles/index.html).
11+
To see an example of this in action, check out the [example Live Style Guide](/examples/styles/index.html).
1212

1313
### What DocumentJS Does
14-
<sup>*[Skip this section](/docs/lsg-quickstart-installation.html) if you're comfortable with magic and don't care how DocumentJS works.*</sup>
14+
<sup>*[Skip this section](/docs/lsg-adding-installation.html) if you're comfortable with magic and don't care how DocumentJS works.*</sup>
1515

1616
DocumentJS is a [*static site generator*](https://staticsitegenerators.net/). This means it scans specially formatted input files and creates a website that remains unchanged until the generator runs again. Whereas in a content management system changes happen somewhat automatically, a static site generator usually needs to be **run manually** and then the generated files must be **uploaded**.
1717

@@ -26,4 +26,4 @@ To build your Live Style Guide, DocumentJS does the following:
2626

2727

2828

29-
[Next Page](/docs/lsg-quickstart-installation.html)
29+
[Next Page](/docs/lsg-adding-installation.html)

docs/livestyleguide/guides/adding/next-steps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
@page lsg-adding-next-steps Writing and Customizing
22
@parent lsg-adding-group-next-steps 0
33

4-
Now that you've finished with installation and configuration, creating pages, documenting, and customizing your site follows the same steps as the [Standalone Style Guide](/docs/lsg-quickstart.html):
4+
Now that you've finished with installation and configuration, the rest of the the process (creating pages, documenting, and customizing your site) will follow the same steps as the [Standalone Style Guide](/docs/lsg-quickstart.html):
55

66
* [Creating a Page](/docs/lsg-quickstart-creating-page.html)
77
* [Generating the Site](/docs/lsg-quickstart-generate.html)

docs/livestyleguide/guides/quickstart.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ This guide will:
1111
* Give a [designer-friendly explanation](/docs/lsg-quickstart-designers.html) of what DocumentJS does
1212
* Help you [install DocumentJS](/docs/lsg-quickstart-installation.html)
1313
* Help you configure a Live Style Guide site
14-
* Explain how to use [tags](/docs/documentjs.tags.html) to write your Live Style Guide
14+
* Explain how to use [tags](http://documentjs.com/docs/documentjs.tags.html) to write your Live Style Guide
1515

1616
You should start elsewhere if:
1717

18-
* You [only care about JavaScript documentation](/docs/index.html)
18+
* You [only care about JavaScript documentation](http://documentjs.com/docs/index.html)
1919
* You already use DocumentJS and want to [add a Live Style Guide](/docs/lsg-adding.html)
20-
* You want to set up DocumentJS for [API documentation](/docs/index.html), then [add a Live Style Guide](/docs/lsg-adding.html)
20+
* You want to set up DocumentJS for [API documentation](http://documentjs.com/docs/index.html), then [add a Live Style Guide](/docs/lsg-adding.html)
2121
* You [are totally lost](https://www.youtube.com/watch?v=I0Pow7Gi7Xw)
2222

2323
[Next Page](/docs/lsg-quickstart-designers.html)

docs/livestyleguide/guides/quickstart/custom-styles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,6 @@ Updated `documentjs.json`:
4141

4242
### Changing the Styles
4343

44-
To see DocumentJS default styles, look in `node_modules/documentjs/site/default/static/styles`. See the documentation for these styles in the [DocumentJS.com Live Style Guide](/styles/variables.less.html). To change any of these styles for your style guide, simply copy one of the files over to `style-guide-theme/styles` and make your changes.
44+
To see DocumentJS default styles, look in `node_modules/documentjs/site/default/static/styles`. See the documentation for these styles in the [example Live Style Guide](/examples/styles/variables.less.html). To change any of these styles for your style guide, simply copy one of the files over to `style-guide-theme/styles` and make your changes.
4545

4646
If you'd like to add a new LESS file, simply copy over `styles.less` (which imports all the stylesheets) and `@@import` your new file. DocumentJS will automatically resolve default file imports for any files you don't copy over so don't worry about fixing the file paths for the `@@import` statement.

docs/livestyleguide/guides/quickstart/demos.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ In `base.less`:
3434
*/
3535
```
3636

37-
On the "Base Styles" stylesheet page generated from `base.less`, there will now be a demo showing whatever page is at `demos/forms.html`. In the [Example Style Guide](/styles/base.less.html), that looks like this:
37+
On the "Base Styles" stylesheet page generated from `base.less`, there will now be a demo showing whatever page is at `demos/forms.html`. In the [Example Style Guide](/examples/styles/base.less.html), that looks like this:
3838

39-
@demo demos/base/forms/demo.html
39+
@demo examples/demos/forms.html
4040

4141

4242
### Arguments
@@ -69,9 +69,9 @@ In `typography.less`:
6969
*/
7070
```
7171

72-
Similar to above, but without the "HTML" tab, there will be a demo. In the [Example Style Guide](/styles/typography.less.html), that looks like this:
72+
Similar to above, but without the "HTML" tab, there will be a demo. In the [Example Style Guide](/examples/styles/typography.less.html), that looks like this:
7373

74-
@iframe demos/typography/headings/demo.html
74+
@iframe examples/demos/headings.html
7575

7676

7777
### Arguments
@@ -80,4 +80,6 @@ Similar to above, but without the "HTML" tab, there will be a demo. In the [Exam
8080
@@iframe FILEPATH
8181
```
8282

83-
Just like with the `@@demo` tag, the `FILEPATH` argument is a link to the location of the demo page.
83+
Just like with the `@@demo` tag, the `FILEPATH` argument is a link to the location of the demo page.
84+
85+
[Next Page](/docs/lsg-custom-styles.html)

docs/livestyleguide/guides/quickstart/fileorganization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ project/
2929
<!-- Automatically generated directory -->
3030
```
3131

32-
[Next Page](/docs/lsg-quickstart-writing.html)
32+
[Next Page](/docs/lsg-quickstart-creating-page.html)

docs/livestyleguide/guides/quickstart/fordesigners.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
@page lsg-quickstart-designers DocumentJS for Designers
22
@parent lsg-quickstart-group-intro 0
33

4-
DocumentJS isn't just for JavaScript API Docs. As long as your project is using [npm](http://npmjs.org), you will be able to:
4+
Though you're documenting your styles, the tool you'll be using is DocumentJS. As long as your project is using [npm](http://npmjs.org), you will be able to:
55

66
* Generate a living site that automatically updates as your project's design evolves
77
* Write a style guide with inline comments in stylesheets or with individual markdown files
88
* Include demos to display examples alongside sample markup
99
* Organize pages into navigation groups like "Elements," "Themes," and "Components"
1010

11-
To see an example of this, check out the DocumentJS.com [Live Style Guide](/examples/styles/index.html).
11+
To see an example of this, check out this site's example [Live Style Guide](/examples/styles/index.html).
1212

1313

1414
### What DocumentJS Does

0 commit comments

Comments
 (0)