You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/zero-to-hero.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ index: 9
5
5
---
6
6
# From zero to hero: deploying to GitHub Pages
7
7
8
-
This guide is meant for a typically setup for open-source projects on GitHub.
8
+
This guide is meant for a typical setup of open-source projects on GitHub.
9
9
We start from a repository without any documentation and aim to end up with a published website on [GitHub Pages](https://pages.github.com/).
10
10
11
11
## Install the local tool
@@ -44,7 +44,7 @@ When `fsdocs` runs, it will transform this `index.md` file to `index.html`, whic
44
44
45
45
We can put `# Hello world` in the markdown file for now.
46
46
47
-
Having this in play, should already serve the first page when we start the `watch` command:
47
+
Having this in place, should already serve the first page when we start the `watch` command:
48
48
49
49
> dotnet fsdocs watch
50
50
@@ -63,7 +63,7 @@ It will filter these found projects, the requirements are:
63
63
- Not having `<IsTestProject>true</IsTestProject>`
64
64
- Having `<GenerateDocumentationFile>true</GenerateDocumentationFile>`
65
65
66
-
🪄 If you made some changes to in order to adhere to the rules, you may want to remove the `.fsdocs/cache` file.
66
+
🪄 If you made some changes in order to adhere to the rules, you may want to remove the `.fsdocs/cache` file.
67
67
68
68
## Adding the missing properties
69
69
@@ -100,9 +100,9 @@ Running `dotnet fsdocs watch` will now yield:
100
100
⚠️ Again, you might need to remove `.fsdocs/cache` in order for changes to be picked up!
101
101
102
102
`<PackageProjectUrl>` is actually a very important property when you run `dotnet fsdocs build`.
103
-
`build` will generated static files for the targeted production environment. In our case, this will be GitHub Pages.
103
+
`build` will generate static files for the targeted production environment. In our case, this will be GitHub Pages.
104
104
105
-
Pages will host your files from https://github.com/user/projectto on `https://user.github.io/project/` by default.
105
+
Pages will host your files from https://github.com/user/project on `https://user.github.io/project/` by default.
106
106
You can change this by adding a custom domain so we need to be sure that all links and urls will be generated correctly during a build.
107
107
108
108
Let's now run `dotnet fsdocs build`.
@@ -113,7 +113,7 @@ Let's now run `dotnet fsdocs build`.
113
113
114
114
## Ignore generated files
115
115
116
-
Alright, at this point we've made a lot of progress. I you are using `git` you want to add the following to your [.gitignore](https://git-scm.com/docs/gitignore) file.
116
+
Alright, at this point we've made a lot of progress. If you are using `git` you want to add the following to your [.gitignore](https://git-scm.com/docs/gitignore) file.
117
117
118
118
```.ignorelang
119
119
# FSharp.Formatting
@@ -189,7 +189,7 @@ jobs:
189
189
190
190
## Next steps
191
191
192
-
Mission accomplished right? If everything went well, you should have a published website at this point!
192
+
Mission accomplished, right? If everything went well, you should have a published website at this point!
0 commit comments