Skip to content

Commit

Permalink
docs: fix typos and tweak grammar (#94)
Browse files Browse the repository at this point in the history
  • Loading branch information
Leon Si authored Oct 5, 2022
1 parent f3e4a95 commit a9706e0
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions guide/hosting.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ download: true
---
```

Slidev will generate a pdf file along with the build, and a download button will be displayed in the SPA.
Slidev will generate a PDF file along with the build, and a download button will be displayed in the SPA.

You can also provide a custom url to the PDF. In that case, the rendering process will be skipped.
You can also provide a custom URL for the PDF. In that case, the rendering process will be skipped.

```md
---
Expand All @@ -52,7 +52,7 @@ For more, check out [Showcases](/showcases).

## Hosting

We recommend to use `npm init slidev@lastest` to scaffolding your project, which contains the necessary configuration files for hosting services out-of-box.
We recommend to use `npm init slidev@latest` to scaffold your project, which contains the necessary configuration files for hosting services out-of-the-box.

### Netlify

Expand All @@ -74,7 +74,7 @@ Create `netlify.toml` in your project root with the following content.
status = 200
```

Then go to your Netlify dashboard, create new site with the repository.
Then go to your Netlify dashboard and create a new site with the repository.

### Vercel

Expand All @@ -90,15 +90,15 @@ Create `vercel.json` in your project root with the following content.
}
```

Then go to your Vercel dashboard, create new site with the repository.
Then go to your Vercel dashboard and create a new site with the repository.

## GitHub Pages

- [GitHub Pages](https://pages.github.com/)

To deploy your slides on GitHub Pages:
- upload all the files of the project in your repo (i.e. named `name_of_repo`)
- create `.github/workflows/deploy.yml` with following content to deploy your slides to GitHub Pages via GitHub Actions. In this file, replace `<name_of_repo>`with `name_of_repo`.
- create `.github/workflows/deploy.yml` with following content to deploy your slides to GitHub Pages via GitHub Actions. In this file, replace `<name_of_repo>` with `name_of_repo`.

```yaml
name: Deploy pages
Expand All @@ -124,5 +124,5 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
- In your repository, go to Setting>Pages. Under "Build and deployment", select "Deploy from a branch", select "gh- pages" and "root". Click on save.
- Finally, after all workflows is executed, a link to the slides should appear under Setting>Pages.
- In your repository, go to Settings>Pages. Under "Build and deployment", select "Deploy from a branch", select "gh-pages" and "root". Click on save.
- Finally, after all workflows are executed, a link to the slides should appear under Settings>Pages.

0 comments on commit a9706e0

Please sign in to comment.