New render template for markdown "md"

pierky / arouteserver

A tool to automatically build (and test) feature-rich configurations for BGP route servers.

https://arouteserver.readthedocs.org/

GNU General Public License v3.0

288 stars 46 forks source link

New render template for markdown "md" #103

Closed KusakabeShi closed 2 years ago

KusakabeShi commented 2 years ago

Similar to html mode, you can generate markdown description now.

arouteserver md -o description.md

Generated markdown from examples/rich: https://hackmd.io/d1OXiMbTSrSsK05LVpxJPg?both

pierky commented 2 years ago

Hi @KusakabeShi, this is great, thanks a lot!

I'm working to finish off the integration of the new md command, adding it to the script that automatically builds the docs and examples. I'll update you here as soon as I'll complete it.

Thanks again!

pierky commented 2 years ago

So far I've pushed some new commits:

237656ff2db05cd227c156f8cae31c5a360314ef Fix impagination Some changes in the template proposed by @KusakabeShi to solve minor impagination issues, mostly on the reject reasons table.
d9033a2f1a27a0314abebec34dcbb666def37c08 Integrate the Markdown representation into docs and examples
2067f3a4f25c49116aebd25b2006653d897cb917 Update docs and examples with Markdown files

The .md can be visualised using GitHub's Markdown rendering from the KusakabeShi-master branch, inside the examples directory (subdirs of it actually).

pierky commented 2 years ago

I've merged your commit along with mine into the "dev" branch and started a pipeline to build and push an alpha version of the next release, that includes the new markdown command.

Assuming that the CI/CD pipeline will succeed, release v1.15.0-alpha1 will be out in about an hour, available on the test instance of PyPi: to install it, instructions can be found at https://arouteserver.readthedocs.io/en/latest/INSTALLATION.html#development-and-pre-release-versions

pierky commented 2 years ago

Thanks again @KusakabeShi, this went into 1.15.0, which is being tested and built right now by the CI/CD pipeline.