[SR-Users] Info: converting dokuwiki content to markdown files

Daniel-Constantin Mierla miconda at gmail.com
Thu May 12 11:04:50 CEST 2022


More on emoji support with mkdocs: I installed the extensions but they
seem to point to CDN sites with links to svg/png images. This is also
done by github when browsing the files in the repo (they point to their
CND server), but I think it's not the optimal solution for the variant
to be stored on kamailio.org, because every time someone loads it from
our website, the emojis are downloaded from the remote CDN servers (can
be slower, privacy concerns, ...).

Apparently it works to paste the UTF-8 character code for the emoji in
the md file and then all looks good in github repo and
mkdocs/mdbook/pandoc output. Therefore I think this is better to do.

For now, my solution for getting the UTF-8 code for a specific emoji is
to select & copy the character from another file having it. For example
open in browser:

  * https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md

Then do "View source", search in it for the emoji you want, e.g.:
":warning:" and you should find something like:

<td align="center"><g-emoji class="g-emoji" alias="warning"
fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/26a0.png">⚠️</g-emoji></td>
<td><code>:warning:</code></td>

The character looks like a small image, respectively the yellow triangle
with exclamation before the end tag </g-emoji>. Select it, copy and
paste in the md file where you want to use it.

Cheers,
Daniel

On 11.05.22 14:17, Daniel-Constantin Mierla wrote:
> On 11.05.22 14:11, Daniel-Constantin Mierla wrote:
>> 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-framework
>>>
>>> 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 at 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/
>>>
>> -- 
>> 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/
>
-- 
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/




More information about the sr-users mailing list