cobweb/xmitter-11ty
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

A bit of README cleanup

Browse Source
This commit is contained in:
Zach Leatherman 2023-04-12 16:48:14 -05:00
parent fd06d3204d
commit 933099a497
1 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -6,35 +6,38 @@ A starter repository showing how to build a blog with the [Eleventy](https://www
## Getting Started ## Getting Started
1. Clone this Repository * [Want a more generic/detailed getting started guide?](https://www.11ty.dev/docs/getting-started/)
``` 1. Make a directory and navigate to it:
git clone https://github.com/11ty/eleventy-base-blog.git my-blog-name
```
2. Navigate to the directory
``` ```
mkdir my-blog-name
cd my-blog-name cd my-blog-name
``` ```
3. Have a look at `eleventy.config.js` to see if you want to configure any Eleventy options differently. 2. Clone this Repository
4. Install dependencies
```
git clone https://github.com/11ty/eleventy-base-blog.git .
```
_Optional:_ Review `eleventy.config.js` and `_data/metadata.js` to configure the site’s options and data.
3. Install dependencies
``` ```
npm install npm install
``` ```
5. Edit `_data/metadata.js` to change the site data. 4. Run Eleventy
6. Run Eleventy
Generate a production-ready build: Generate a production-ready build to the `_site` folder:
``` ```
npx @11ty/eleventy npx @11ty/eleventy
``` ```
Or build and host locally on a local development server: Or build and host on a local development server:
``` ```
npx @11ty/eleventy --serve npx @11ty/eleventy --serve