From 01ca60c4c23988b938c90de92e520332c82390f6 Mon Sep 17 00:00:00 2001 From: Omikhleia Date: Fri, 11 Aug 2023 14:31:20 +0200 Subject: [PATCH] chore: Start versioning rocks --- README.md | 12 +++---- examples/introduction.md | 17 +++++----- examples/sile-and-pandoc.dj | 2 +- markdown.sile-1.4.1-1.rockspec | 60 ++++++++++++++++++++++++++++++++++ 4 files changed, 74 insertions(+), 17 deletions(-) create mode 100644 markdown.sile-1.4.1-1.rockspec diff --git a/README.md b/README.md index c6a2982..c801234 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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: diff --git a/examples/introduction.md b/examples/introduction.md index 646753e..d7f9280 100644 --- a/examples/introduction.md +++ b/examples/introduction.md @@ -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 @@ -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. @@ -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: diff --git a/examples/sile-and-pandoc.dj b/examples/sile-and-pandoc.dj index 0309352..e4af062 100644 --- a/examples/sile-and-pandoc.dj +++ b/examples/sile-and-pandoc.dj @@ -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 diff --git a/markdown.sile-1.4.1-1.rockspec b/markdown.sile-1.4.1-1.rockspec new file mode 100644 index 0000000..604f7ef --- /dev/null +++ b/markdown.sile-1.4.1-1.rockspec @@ -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", + } +}