12 May
2022
12 May
'22
5:36 a.m.
I looked hugo today, and looks like we have to add yaml meta data to each
markdown file and relocate files to follow the hugo convention. The worse
things is, different themes have different conventions. while we will
eventually use one theme, but it's not easy to try different themes, we
will have to play themes if we make it better later, but we don't want to
be expert on hugo.
So as mkdocs kind of work, maybe we can stick with it. I also played some
css tricks to pin the TOC to the left of the page if we use pandoc. the PR
maybe not ready to merge before we figure out the path problem.
https://github.com/kamailio/kamailio-wiki/pull/5
On Wed, May 11, 2022 at 8:19 PM Daniel-Constantin Mierla <miconda(a)gmail.com>
wrote:
On 11.05.22 14:11, Daniel-Constantin Mierla wrote:
--
Daniel-Constantin Mierla -- www.asipto.com
www.twitter.com/miconda -- www.linkedin.com/in/miconda
Kamailio Advanced Training - Online: June 20-23, 2022
* https://www.asipto.com/sw/kamailio-advanced-training-online/
--
Daniel-Constantin Mierla -- www.asipto.com
www.twitter.com/miconda -- www.linkedin.com/in/miconda
Kamailio Advanced Training - Online: June 20-23, 2022
* https://www.asipto.com/sw/kamailio-advanced-training-online/
__________________________________________________________
Kamailio - Users Mailing List - Non Commercial Discussions
* sr-users(a)lists.kamailio.org
Important: keep the mailing list in the recipients, do not reply only to
the sender!
Edit mailing list options or unsubscribe:
* https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users
--
About: http://about.me/dujinfang
Blog: http://www.dujinfang.com
Other: http://rts.cn
I played a bit with mkdocs on kamailio-wiki files
and published the html
output at:
* https://www.kamailio.org/wikidocs/
Following up: I noticed mkdocs does not support emoji (which I thought
of using to highlight paragraphs, notes, etc.), but there seem to be
extensions for it.
Cheers,
Daniel
Some internal links may not work because I noticed warnings when mkdocs
was building the html pages, I will review and fix when I get a chance.
The kamailio-wiki gtihub repo has now a Makefile that enables building
html files using pandoc or mkdocs. Maybe someone can contribute support
for using hugo or other static site generator, then we can decide in the
community which result is better to publish on the website.
Cheers,
Daniel
On 10.05.22 16:31, Daniel-Constantin Mierla wrote:
> Thanks for the useful details about hugo!
>
> For the records, in the past we used the mkdocs for a couple of
> tutorials, like the one for KEMI framework or install guidelines, eg:
>
> *
https://www.kamailio.org/docs/tutorials/devel/kamailio-kemi-framework/
>
> Built from:
>
> *
>
https://github.com/kamailio/kamailio-docs/tree/master/kamailio-kemi-framewo…
>
> But I can't say I am that familiar with it to assert if it is the best
> one for the wiki, which has lot of content and some pages could end up
> with large ToC (e.g., the cookbooks for core, variables, ...).
>
> Anyhow, let's have it in the list and see if we get more feedback or
> other suggestions from the community.
>
> Cheers,
> Daniel
>
> On 10.05.22 13:01, Greg Troxel wrote:
>> Daniel-Constantin Mierla <miconda(a)gmail.com> writes:
>>
>>> Ideally it is an app that can run on or behind a http server/proxy and
>>> serve html pages generated from the .md files directly from the folder
>>> with the clone of the github repo. But maybe I ask too much and
adapting
>>> the wiki structure for a static site
generator from .md files is
enough
>>> or even better.
>> I have been slowly converting my own content to hugo. It's a very
>> straightforward static site generator, and it runs very quickly.
>>
>> It also has a built-in webserver, and by default it watches the content
>> files and provides the built website on port 127.0.0.1:1313. This is
>> intended for previewing while editing - once you save a file the
browser
window gets the new content in under a second.
So if you either make hugo use your layout, or adapt to hugo's idea of
layout (which is quite sane), then not only can bits be pushed to a
server, but "hugo server" will make them available.
So if I were tackling this, of all the options listed, I would lean
strongly to hugo.
--
Daniel-Constantin Mierla -- www.asipto.com
www.twitter.com/miconda -- www.linkedin.com/in/miconda
Kamailio Advanced Training - Online: June 20-23, 2022
* https://www.asipto.com/sw/kamailio-advanced-training-online/