Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yuma140902 committed Jan 12, 2024
1 parent 2015725 commit a5bbc24
Showing 1 changed file with 0 additions and 51 deletions.
51 changes: 0 additions & 51 deletions README.md
Expand Up @@ -41,63 +41,12 @@ cargo binstall tempura

## Example

> The content of this section is out of date. It contains information for v0.3.x, but the latest version is v0.5.x. Please wait for updates.
### yuma14.net

- Repo: <https://github.com/yuma140902/yuma140902.github.io/>
- Generated website: <https://www.yuma14.net/>

### tempura-example

- Repo: <https://github.com/yuma140902/tempura-example>
- Generated website: <https://yuma14.net/tempura-example/sample.html>

## Documentation

> The content of this section is out of date. It contains information for v0.3.x, but the latest version is v0.5.x. Please wait for updates.
https://yuma14.net/tempura-doc/

## General Usage

> The content of this section is out of date. It contains information for v0.3.x, but the latest version is v0.5.x. Please wait for updates.
### 1. Setup project

Run `tempura init my_project`.

The following directories and files will be created.

```text
my_project
│ tempura.json
├─public
└─src
├─pages
│ │ sample.md
│ │ style.css
│ │
│ └─sub_dir
│ sample2.md
└─templates
page.html.hbs
```

### 2. Edit

Edit template files and markdown files as you like.

See also [Handlebars Language Guide](https://handlebarsjs.com/guide/) and [CommonMark Specification](https://spec.commonmark.org/current/). It is possible to write front matter, which is out of CommonMark specification.

### 3. Build

Run `cd my_project && tempura build`.

HTML files are generated in the `my_project/public/` directory.

### 4. Deploy

Copy contents of `my_project/public/` to your server.

0 comments on commit a5bbc24

Please sign in to comment.