Skip to content

Commit

Permalink
chore: Start versioning rocks
Browse files Browse the repository at this point in the history
  • Loading branch information
Omikhleia authored and Didier Willis committed Aug 11, 2023
1 parent db66785 commit 01ca60c
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 17 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,13 @@ This module collection requires SILE v0.14 or upper.

Installation relies on the **luarocks** package manager.

To install the latest development version, you may use the provided “rockspec”:
To install the latest version, you may use the provided “rockspec”:

```
luarocks --lua-version 5.4 install --dev markdown.sile
luarocks install markdown.sile
```

(Adapt to your version of Lua, if need be, and refer to the SILE manual for more
detailed 3rd-party package installation information.)
(Refer to the SILE manual for more detailed 3rd-party package installation information.)

## Usage

Expand All @@ -51,9 +50,8 @@ Or from documents (e.g. here in SIL language):
\include[src=somefile.md]
```

Other possibilities exist (such as setting `format=markdown` on the `\include` command, if the file extension
cannot be one of the supported variants, etc.). Refer to the SILE manual for more details on inputters and their
usage.
Other possibilities exist (such as setting `format=markdown` on the `\include` command, if the file extension cannot be one of the supported variants, etc.).
Refer to the SILE manual for more details on inputters and their usage.

Including raw Markdown content from within a document in SIL syntax is also possible:

Expand Down
17 changes: 8 additions & 9 deletions examples/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,20 @@ Each of them has its advantages, and a few limitations as well.

![Supported routes from input to output.](./markdown-sile-overview.dot){width="96%fw"}

## Installation and usage

### Installation
## Installation

This module collection requires SILE v0.14 or upper.

Installation relies on the **luarocks** package manager.
To install the latest development version, you may use the provided “rockspec”:
To install the latest version, you may use the provided “rockspec”:

```bash
luarocks --lua-version 5.4 install --dev markdown.sile
luarocks install markdown.sile
```

Adapt to your version of Lua, if need be, and refer to the SILE manual for more
detailed 3rd-party package installation information.
Refer to the SILE manual for more detailed 3rd-party package installation information.

## Usage

### Usage from command line

Expand Down Expand Up @@ -60,7 +59,7 @@ You don't really have to know that, unless you intend to invoke SILE with the `-
To unleash the full potential of this package collection, we recommend that you also install our [**resilient.sile**](https://github.com/Omikhleia/resilient.sile) collection of classes and packages.

```bash
luarocks --lua-version 5.4 install --dev resilient.sile
luarocks install resilient.sile
```

Then, you can automatically benefit from a few advanced features.
Expand All @@ -85,7 +84,7 @@ These are described further in this guide.

The resilient collection also introduces a "master document" format, streamlining several usual tasks. Give it a chance, and you may even end up producing a book with SILE without a single statement in SIL.

### Credits
## Credits

Additional thanks to:

Expand Down
2 changes: 1 addition & 1 deletion examples/sile-and-pandoc.dj
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The latter, though, do not offer as many options and extensions as Pandoc does,

In the event where the native solution would fall short for you ---e.g. would you need some extension of feature it doesn't yet support--- you may want to use Pandoc directly for converting your document to an output suitable for SILE.

The following solutions are still experimental proof-of-concepts, but you may give them a chance,and help us fill the gaps.
The following solutions are still experimental proof-of-concepts, but you may give them a chance, and help us fill the gaps.

## Using Pandoc's AST with the pandocast package

Expand Down
60 changes: 60 additions & 0 deletions markdown.sile-1.4.1-1.rockspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
rockspec_format = "3.0"
package = "markdown.sile"
version = "1.4.1-1"
source = {
url = "git+https://github.com/Omikhleia/markdown.sile.git",
tag = "v1.4.1",
}
description = {
summary = "Native Markdown support for the SILE typesetting system.",
detailed = [[
This package set for the SILE typesetting system provides a complete redesign
of the native Markdown support for SILE, with a great set of Pandoc-like
extensions and plenty of extra goodies.
]],
homepage = "https://github.com/Omikhleia/markdown.sile",
license = "MIT",
}
dependencies = {
"lua >= 5.1",
"embedders.sile >= 0.1.0",
"labelrefs.sile >= 0.1.0",
"ptable.sile >= 2.0.0",
"smartquotes.sile >= 1.0.0",
"textsubsuper.sile >= 1.0.0",
"silex.sile >= 0.1.0",
}

build = {
type = "builtin",
modules = {
["sile.classes.markdown"] = "classes/markdown.lua",
["sile.inputters.markdown"] = "inputters/markdown.lua",
["sile.inputters.pandocast"] = "inputters/pandocast.lua",
["sile.inputters.djot"] = "inputters/djot.lua",
["sile.packages.markdown"] = "packages/markdown/init.lua",
["sile.packages.markdown.commands"] = "packages/markdown/commands.lua",
["sile.packages.markdown.utils"] = "packages/markdown/utils.lua",
["sile.packages.pandocast"] = "packages/pandocast/init.lua",
["sile.packages.djot"] = "packages/djot/init.lua",

["sile.lunamark"] = "lua-libraries/lunamark.lua",
["sile.lunamark.entities"] = "lua-libraries/lunamark/entities.lua",
["sile.lunamark.reader"] = "lua-libraries/lunamark/reader.lua",
["sile.lunamark.reader.markdown"] = "lua-libraries/lunamark/reader/markdown.lua",
["sile.lunamark.util"] = "lua-libraries/lunamark/util.lua",
["sile.lunamark.writer"] = "lua-libraries/lunamark/writer.lua",
["sile.lunamark.writer.generic"] = "lua-libraries/lunamark/writer/generic.lua",
["sile.lunamark.writer.html"] = "lua-libraries/lunamark/writer/html.lua",
["sile.lunamark.writer.html5"] = "lua-libraries/lunamark/writer/html5.lua",

["sile.djot"] = "lua-libraries/djot.lua",
["sile.djot.attributes"] = "lua-libraries/djot/attributes.lua",
["sile.djot.json"] = "lua-libraries/djot/json.lua",
["sile.djot.block"] = "lua-libraries/djot/block.lua",
["sile.djot.inline"] = "lua-libraries/djot/inline.lua",
["sile.djot.html"] = "lua-libraries/djot/html.lua",
["sile.djot.ast"] = "lua-libraries/djot/ast.lua",
["sile.djot.filter"] = "lua-libraries/djot/filter.lua",
}
}

0 comments on commit 01ca60c

Please sign in to comment.