Skip to content

Commit d4fa640

Browse files
authored
Update README.md (#182)
1 parent f8e0fe9 commit d4fa640

File tree

1 file changed

+26
-22
lines changed

1 file changed

+26
-22
lines changed

README.md

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -25,46 +25,50 @@ The repository also includes a [docfx.json](docfx.json) file. You can use [DocFX
2525
## Build an HTML Website
2626
Follow the steps below to create a documentation website for your application.
2727

28-
- Download and install the [latest version of DocFX](https://github.com/dotnet/docfx/releases).
29-
- Copy the repository to your computer and checkout the branch corresponding to the version of DevExpress controls your application uses. Do not use the **master** branch because it represents the version currently under development.
28+
1. Download and install the [latest version of DocFX](https://github.com/dotnet/docfx/releases).
29+
1. Copy the repository to your computer and checkout the branch corresponding to the version of DevExpress controls your application uses. Do not use the **master** branch because it represents the version currently under development.
3030
```
31-
git clone https://github.com/DevExpress/dotnet-eud.git --branch 18.1
31+
git clone https://github.com/DevExpress/dotnet-eud.git
32+
git switch 20.1
3233
```
33-
If you do not have [Git](https://git-scm.com/) installed, use the GitHub web interface to select the branch and then download and extract the ZIP archive.
34+
If you do not have [Git](https://git-scm.com/) installed, use the GitHub web interface to select the branch and then download and extract the ZIP archive.
3435
35-
![Download ZIP](https://user-images.githubusercontent.com/20167812/29712204-4ffaee9e-89a1-11e7-8a0e-3ff0464adda4.png)
36-
- You can make the following changes to the documentation, or skip this step if you want to reuse the end-user documentation as is:
37-
- remove unnecessary files;
38-
- add new documents to your application;
39-
- change screenshots to match your app's UI;
40-
- create a [custom DocFX template](https://dotnet.github.io/docfx/tutorial/howto_create_custom_template.html).
41-
> You should update the *toc.yml* ([table-of-content](https://dotnet.github.io/docfx/tutorial/intro_toc.html)) files if you added or removed topics.
42-
- Open a console window, change the current directory to the repository root folder and call the DocFX executable with the *build* and *docfx.json* parameters. DocFX will place the generated documentation content into the *\_site* folder. Add the `--serve` switch to preview the generated website at http://localhost:8080 once the build process is complete.
36+
![Download ZIP](https://user-images.githubusercontent.com/20167812/29712204-4ffaee9e-89a1-11e7-8a0e-3ff0464adda4.png)
37+
1. You can make the following changes to the documentation, or skip this step if you want to reuse the end-user documentation as is:
38+
39+
- remove unnecessary files;
40+
- add new documents to your application;
41+
- change screenshots to match your app's UI;
42+
- create a [custom DocFX template](https://dotnet.github.io/docfx/tutorial/howto_create_custom_template.html).
43+
44+
> You should update the *toc.yml* ([table-of-content](https://dotnet.github.io/docfx/tutorial/intro_toc.html)) files if you added or removed topics.
45+
1. Open a console window, change the current directory to the repository root folder and call the DocFX executable with the *build* and *docfx.json* parameters. Specify a path to *docfx.json* in the _dotnet-eud_ downloaded reporisoty. DocFX will place the generated documentation content into the *\_site* folder. Add the `--serve` switch to preview the generated website at http://localhost:8080 once the build process is complete.
4346
```
44-
docfx.exe build docfx.json --serve
47+
docfx.exe build ../dotnet-eud/docfx.json --serve
4548
```
46-
- Finally, deploy the created documentation to a web server or browse the documentation directly from local file system. Since DocFX creates static HTML files only, no additional deployment or configuration steps are required.
49+
1. Deploy the created documentation to a web server or browse the documentation directly from local file system. Since DocFX creates static HTML files only, no additional deployment or configuration steps are required.
4750
4851
## Build Printer-Friendly PDF Files
49-
If your end users require a printed version, you can create a PDF file:
52+
If your end users require a printed version, you can build a PDF file like this:
5053
51-
- Ensure that you can successfully [build a website with DocFX](#build-your-own-documentation-website).
52-
- Download and install [wkhtmltopdf](https://wkhtmltopdf.org/downloads.html).
53-
- In the folder with `docfx.exe`, open a console window and add the `wkhtmltopdf` executable path to the `%PATH%` environment variable:
54+
1. Ensure that you can successfully [build a website with DocFX](#build-your-own-documentation-website).
55+
1. Download and install [wkhtmltopdf](https://wkhtmltopdf.org/downloads.html).
56+
1. In the folder with `docfx.exe`, open a console window and add the `wkhtmltopdf` executable path to the `%PATH%` environment variable:
5457
5558
```
5659
set PATH=%PATH%;C:\Program Files\wkhtmltopdf\bin
5760
```
5861
59-
- Build pdf:
62+
1. Build pdf:
6063
6164
```
6265
docfx.exe pdf ../dotnet-eud/docfx.json
6366
```
6467
65-
This generates a *_pdf* subfоlder with a PDF file for each included table-of-contents file.
68+
This generates a *_pdf* subfоlder with a PDF file for each included table-of-contents file. Note that this is a time-consuming process.
6669
6770
## Troubleshooting
71+
6872
Below are the common issues you can face when building this repository's documentation.
6973
7074
* #### The build process fails with the *System.IO.PathTooLongException* exception
@@ -80,11 +84,11 @@ Below are the common issues you can face when building this repository's documen
8084
* #### The table of contents is not displayed when browsing the generated documentation from the file system
8185
Your browser security configuration may restrict executing the JavaScript code that accesses your local files (the table of contents is in a separate *toc.html* file when using the [default](https://github.com/dotnet/docfx/tree/dev/src/docfx.website.themes/default) DocFX template). In this case, you can use the [statictoc](https://github.com/dotnet/docfx/tree/dev/src/docfx.website.themes/statictoc) template instead. To switch to this template, add `--template statictoc` to the docfx.exe parameters:
8286
```
83-
docfx.exe build docfx.json --template statictoc
87+
docfx.exe build ../dotnet-eud/docfx.json --template statictoc
8488
```
8589
The table of contents is embedded into each topic with this template which increases the build time and HTML file sizes. Alternatively, you can override the browser's restrictions (which may be unsecure). For example, Google Chrome and Microsoft Edge accept the `--allow-file-access-from-files` command line switch which allows loading local files.
8690
87-
> We recommend using the `--serve` DocFX switch to preview documentation, and then share it with end users via a web server instead of browsing the file system.
91+
> We recommend you to use the `--serve` DocFX switch to preview documentation, and then share it with end users via a web server instead of browsing the file system.
8892
8993
If your issue is not listed, you can [submit a new issue to this repository](https://github.com/DevExpress/dotnet-eud/issues/new) or contact us via the [DevExpress Support Center](https://www.devexpress.com/Support/Center/). You can search the [DocFX issues list](https://github.com/dotnet/docfx/issues), or try building the [docfx\-seed](https://github.com/docascode/docfx-seed) sample documentation project to check if your issue is specific to this repository.
9094

0 commit comments

Comments
 (0)