update astro.config.js to astro.config.mjs in docs

This commit is contained in:
Fred K. Schott 2021-07-20 13:58:14 -07:00
parent ec4e00a8c1
commit 9f6ec661e2
2 changed files with 6 additions and 6 deletions

View file

@ -30,7 +30,7 @@ By default, the build output will be placed at `dist/`. You may deploy this `dis
## GitHub Pages ## GitHub Pages
1. Set the correct `buildOptions.site` in `astro.config.js`. 1. Set the correct `buildOptions.site` in `astro.config.mjs`.
2. Run `touch public/.nojekyll` to create a `.nojekyll` file in `public/`. This [bypasses GitHub Page's default behavior](https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/) to ignore paths prefixed with `_`. 2. Run `touch public/.nojekyll` to create a `.nojekyll` file in `public/`. This [bypasses GitHub Page's default behavior](https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/) to ignore paths prefixed with `_`.
3. Inside your project, create `deploy.sh` with the following content (uncommenting the appropriate lines), and run it to deploy: 3. Inside your project, create `deploy.sh` with the following content (uncommenting the appropriate lines), and run it to deploy:
@ -70,7 +70,7 @@ TODO: We'd love an example action snippet to share here!
### Travis CI ### Travis CI
1. Set the correct `buildOptions.site` in `astro.config.js`. 1. Set the correct `buildOptions.site` in `astro.config.mjs`.
2. Create a file named `.travis.yml` in the root of your project. 2. Create a file named `.travis.yml` in the root of your project.
3. Run `npm install` locally and commit the generated lockfile (`package-lock.json`). 3. Run `npm install` locally and commit the generated lockfile (`package-lock.json`).
4. Use the GitHub Pages deploy provider template, and follow the [Travis CI documentation](https://docs.travis-ci.com/user/deployment/pages/). 4. Use the GitHub Pages deploy provider template, and follow the [Travis CI documentation](https://docs.travis-ci.com/user/deployment/pages/).
@ -97,8 +97,8 @@ TODO: We'd love an example action snippet to share here!
## GitLab Pages ## GitLab Pages
1. Set the correct `buildOptions.site` in `astro.config.js`. 1. Set the correct `buildOptions.site` in `astro.config.mjs`.
2. Set `build.outDir` in `astro.config.js` to `public`. 2. Set `build.outDir` in `astro.config.mjs` to `public`.
3. Create a file called `.gitlab-ci.yml` in the root of your project with the content below. This will build and deploy your site whenever you make changes to your content: 3. Create a file called `.gitlab-ci.yml` in the root of your project with the content below. This will build and deploy your site whenever you make changes to your content:
```yaml ```yaml

View file

@ -18,7 +18,7 @@ Also, Astro supports third-party plugins for Markdown. You can provide your plug
If you want to add a plugin, you need to install the npm package dependency in your project and then update the `markdownOptions.remarkPlugins` or `markdownOptions.rehypePlugins` depends on what plugin you want to have: If you want to add a plugin, you need to install the npm package dependency in your project and then update the `markdownOptions.remarkPlugins` or `markdownOptions.rehypePlugins` depends on what plugin you want to have:
```js ```js
// astro.config.js // astro.config.mjs
export default { export default {
markdownOptions: { markdownOptions: {
remarkPlugins: [ remarkPlugins: [
@ -40,7 +40,7 @@ export default {
You can provide names of the plugins as well as import them: You can provide names of the plugins as well as import them:
```js ```js
// astro.config.js // astro.config.mjs
export default { export default {
markdownOptions: { markdownOptions: {
remarkPlugins: [ remarkPlugins: [