Add docs and fix for latest lustre_ssg
This commit is contained in:
parent
a634ef21ff
commit
ef3aa37475
4 changed files with 46 additions and 9 deletions
9
CHANGELOG.md
Normal file
9
CHANGELOG.md
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
# Changelog
|
||||||
|
|
||||||
|
## 1.0.1
|
||||||
|
|
||||||
|
Fix dependency to `lustre_ssg`.
|
||||||
|
|
||||||
|
## 1.0.0
|
||||||
|
|
||||||
|
Initial release.
|
25
README.md
25
README.md
|
@ -56,8 +56,31 @@ pub fn build(config: Configuration) {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Now you will need to add source files. Create the following directory tree in the root of the project
|
||||||
|
folder:
|
||||||
|
|
||||||
|
```
|
||||||
|
your_project
|
||||||
|
└── data
|
||||||
|
├── pages
|
||||||
|
└── posts
|
||||||
|
```
|
||||||
|
|
||||||
|
In `./data/posts`, create a file `2024-04-21-hello-world.md` with the following contents:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
Hello, World!
|
||||||
|
meta
|
||||||
|
|
||||||
|
This is the first blog entry.
|
||||||
|
```
|
||||||
|
|
||||||
|
Then run `gleam run --target javascript` to build the blog and see what was generated in `./output`.
|
||||||
|
|
||||||
|
For further usage help, see the documentation as described below.
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
- [Scriptorium Demo Blog](https://nicd.gitlab.io/scriptorium_blog)
|
|
||||||
- [User's Guide](https://nicd.gitlab.io/scriptorium_blog/guide.html)
|
- [User's Guide](https://nicd.gitlab.io/scriptorium_blog/guide.html)
|
||||||
- [Scriptorium API reference](https://hexdocs.pm/scriptorium)
|
- [Scriptorium API reference](https://hexdocs.pm/scriptorium)
|
||||||
|
- [Scriptorium Demo Blog](https://nicd.gitlab.io/scriptorium_blog)
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
name = "scriptorium"
|
name = "scriptorium"
|
||||||
version = "1.0.0"
|
version = "1.0.1"
|
||||||
target = "javascript"
|
target = "javascript"
|
||||||
gleam = "~> 1.1"
|
gleam = "~> 1.1"
|
||||||
|
|
||||||
|
@ -17,10 +17,15 @@ links = [
|
||||||
# For a full reference of all the available options, you can have a look at
|
# For a full reference of all the available options, you can have a look at
|
||||||
# https://gleam.run/writing-gleam/gleam-toml/.
|
# https://gleam.run/writing-gleam/gleam-toml/.
|
||||||
|
|
||||||
|
[documentation]
|
||||||
|
pages = [
|
||||||
|
{ title = "Changelog", path = "changelog.html", source = "./CHANGELOG.md" },
|
||||||
|
]
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
gleam_stdlib = "~> 0.36 or ~> 1.0"
|
gleam_stdlib = "~> 0.36 or ~> 1.0"
|
||||||
lustre = "~> 4.1"
|
lustre = "~> 4.1"
|
||||||
lustre_ssg = "~> 0.5.0"
|
lustre_ssg = "~> 0.6.0"
|
||||||
gleam_javascript = "~> 0.8"
|
gleam_javascript = "~> 0.8"
|
||||||
ranged_int = "~> 2.0"
|
ranged_int = "~> 2.0"
|
||||||
bigi = "~> 3.0"
|
bigi = "~> 3.0"
|
||||||
|
|
|
@ -8,11 +8,11 @@ packages = [
|
||||||
{ name = "gleam_javascript", version = "0.8.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_javascript", source = "hex", outer_checksum = "14D5B7E1A70681E0776BF0A0357F575B822167960C844D3D3FA114D3A75F05A8" },
|
{ name = "gleam_javascript", version = "0.8.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_javascript", source = "hex", outer_checksum = "14D5B7E1A70681E0776BF0A0357F575B822167960C844D3D3FA114D3A75F05A8" },
|
||||||
{ name = "gleam_json", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib", "thoas"], otp_app = "gleam_json", source = "hex", outer_checksum = "8B197DD5D578EA6AC2C0D4BDC634C71A5BCA8E7DB5F47091C263ECB411A60DF3" },
|
{ name = "gleam_json", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib", "thoas"], otp_app = "gleam_json", source = "hex", outer_checksum = "8B197DD5D578EA6AC2C0D4BDC634C71A5BCA8E7DB5F47091C263ECB411A60DF3" },
|
||||||
{ name = "gleam_otp", version = "0.10.0", build_tools = ["gleam"], requirements = ["gleam_erlang", "gleam_stdlib"], otp_app = "gleam_otp", source = "hex", outer_checksum = "0B04FE915ACECE539B317F9652CAADBBC0F000184D586AAAF2D94C100945D72B" },
|
{ name = "gleam_otp", version = "0.10.0", build_tools = ["gleam"], requirements = ["gleam_erlang", "gleam_stdlib"], otp_app = "gleam_otp", source = "hex", outer_checksum = "0B04FE915ACECE539B317F9652CAADBBC0F000184D586AAAF2D94C100945D72B" },
|
||||||
{ name = "gleam_stdlib", version = "0.36.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "C0D14D807FEC6F8A08A7C9EF8DFDE6AE5C10E40E21325B2B29365965D82EB3D4" },
|
{ name = "gleam_stdlib", version = "0.37.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "5398BD6C2ABA17338F676F42F404B9B7BABE1C8DC7380031ACB05BBE1BCF3742" },
|
||||||
{ name = "gleeunit", version = "1.1.2", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "72CDC3D3F719478F26C4E2C5FED3E657AC81EC14A47D2D2DEBB8693CA3220C3B" },
|
{ name = "gleeunit", version = "1.1.2", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "72CDC3D3F719478F26C4E2C5FED3E657AC81EC14A47D2D2DEBB8693CA3220C3B" },
|
||||||
{ name = "jot", version = "0.3.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "jot", source = "hex", outer_checksum = "574A2DACA106E9B4826C9F3F2D3911844C7826D554C08E404696CC16F85E0392" },
|
{ name = "jot", version = "0.4.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "jot", source = "hex", outer_checksum = "B20A745707EE60B857249D4533656A52964EA024E844005C4AD8135ED432D66C" },
|
||||||
{ name = "lustre", version = "4.1.5", build_tools = ["gleam"], requirements = ["gleam_erlang", "gleam_json", "gleam_otp", "gleam_stdlib"], otp_app = "lustre", source = "hex", outer_checksum = "C90B3DC868D346C49E98C8A62F2E594AE559D5FF25A46269D60FAA5939FCE827" },
|
{ name = "lustre", version = "4.1.8", build_tools = ["gleam"], requirements = ["gleam_erlang", "gleam_json", "gleam_otp", "gleam_stdlib"], otp_app = "lustre", source = "hex", outer_checksum = "55C3D26AEE6BF6B859927616B1F5BC25841926E4EA6A2A72ECC90D6769560F04" },
|
||||||
{ name = "lustre_ssg", version = "0.5.0", build_tools = ["gleam"], requirements = ["gleam_stdlib", "jot", "lustre", "simplifile", "tom"], otp_app = "lustre_ssg", source = "hex", outer_checksum = "F208FC79C25AE70976AEA2BA4262760BCC5C807E637742FEF66F0692150039C6" },
|
{ name = "lustre_ssg", version = "0.6.0", build_tools = ["gleam"], requirements = ["gleam_stdlib", "jot", "lustre", "simplifile", "tom"], otp_app = "lustre_ssg", source = "hex", outer_checksum = "F89A4246C011DC8A417A62F53003B525BA39AD86099DFE62C2E942296976897A" },
|
||||||
{ name = "ranged_int", version = "2.0.0", build_tools = ["gleam"], requirements = ["bigi", "gleam_stdlib"], otp_app = "ranged_int", source = "hex", outer_checksum = "9FCDA804C1884015FC25F3F8BE429FC450D402F861B5C561464479F5B1162A41" },
|
{ name = "ranged_int", version = "2.0.0", build_tools = ["gleam"], requirements = ["bigi", "gleam_stdlib"], otp_app = "ranged_int", source = "hex", outer_checksum = "9FCDA804C1884015FC25F3F8BE429FC450D402F861B5C561464479F5B1162A41" },
|
||||||
{ name = "simplifile", version = "1.7.0", build_tools = ["gleam"], requirements = ["filepath", "gleam_stdlib"], otp_app = "simplifile", source = "hex", outer_checksum = "1D5DFA3A2F9319EC85825F6ED88B8E449F381B0D55A62F5E61424E748E7DDEB0" },
|
{ name = "simplifile", version = "1.7.0", build_tools = ["gleam"], requirements = ["filepath", "gleam_stdlib"], otp_app = "simplifile", source = "hex", outer_checksum = "1D5DFA3A2F9319EC85825F6ED88B8E449F381B0D55A62F5E61424E748E7DDEB0" },
|
||||||
{ name = "thoas", version = "0.4.1", build_tools = ["rebar3"], requirements = [], otp_app = "thoas", source = "hex", outer_checksum = "4918D50026C073C4AB1388437132C77A6F6F7C8AC43C60C13758CC0ADCE2134E" },
|
{ name = "thoas", version = "0.4.1", build_tools = ["rebar3"], requirements = [], otp_app = "thoas", source = "hex", outer_checksum = "4918D50026C073C4AB1388437132C77A6F6F7C8AC43C60C13758CC0ADCE2134E" },
|
||||||
|
@ -25,6 +25,6 @@ gleam_javascript = { version = "~> 0.8" }
|
||||||
gleam_stdlib = { version = "~> 0.36 or ~> 1.0" }
|
gleam_stdlib = { version = "~> 0.36 or ~> 1.0" }
|
||||||
gleeunit = { version = "~> 1.0" }
|
gleeunit = { version = "~> 1.0" }
|
||||||
lustre = { version = "~> 4.1" }
|
lustre = { version = "~> 4.1" }
|
||||||
lustre_ssg = { version = "~> 0.5.0" }
|
lustre_ssg = { version = "~> 0.6.0" }
|
||||||
ranged_int = { version = "~> 2.0" }
|
ranged_int = { version = "~> 2.0" }
|
||||||
simplifile = { version = "~> 1.7"}
|
simplifile = { version = "~> 1.7" }
|
||||||
|
|
Loading…
Reference in a new issue