summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Fred K. Schott <fkschott@gmail.com> 2021-07-20 13:58:14 -0700
committerGravatar Fred K. Schott <fkschott@gmail.com> 2021-07-20 13:58:29 -0700
commit9f6ec661e2ebfc703c5c527bd7a883f9c34287a7 (patch)
tree70f365898df0cefbf70868855ff0130d63489d7e
parentec4e00a8c180ec1736c88245fa7c92469b0254b7 (diff)
downloadastro-9f6ec661e2ebfc703c5c527bd7a883f9c34287a7.tar.gz
astro-9f6ec661e2ebfc703c5c527bd7a883f9c34287a7.tar.zst
astro-9f6ec661e2ebfc703c5c527bd7a883f9c34287a7.zip
update astro.config.js to astro.config.mjs in docs
Diffstat (limited to '')
-rw-r--r--docs/src/pages/guides/deploy.md8
-rw-r--r--docs/src/pages/guides/markdown-content.md4
2 files changed, 6 insertions, 6 deletions
diff --git a/docs/src/pages/guides/deploy.md b/docs/src/pages/guides/deploy.md
index 79b3075a1..73b7942c1 100644
--- a/docs/src/pages/guides/deploy.md
+++ b/docs/src/pages/guides/deploy.md
@@ -30,7 +30,7 @@ By default, the build output will be placed at `dist/`. You may deploy this `dis
## 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 `_`.
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
-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.
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/).
@@ -97,8 +97,8 @@ TODO: We'd love an example action snippet to share here!
## GitLab Pages
-1. Set the correct `buildOptions.site` in `astro.config.js`.
-2. Set `build.outDir` in `astro.config.js` to `public`.
+1. Set the correct `buildOptions.site` in `astro.config.mjs`.
+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:
```yaml
diff --git a/docs/src/pages/guides/markdown-content.md b/docs/src/pages/guides/markdown-content.md
index 5a8cebed0..9c6c5b78c 100644
--- a/docs/src/pages/guides/markdown-content.md
+++ b/docs/src/pages/guides/markdown-content.md
@@ -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:
```js
-// astro.config.js
+// astro.config.mjs
export default {
markdownOptions: {
remarkPlugins: [
@@ -40,7 +40,7 @@ export default {
You can provide names of the plugins as well as import them:
```js
-// astro.config.js
+// astro.config.mjs
export default {
markdownOptions: {
remarkPlugins: [