[prev in list] [next in list] [prev in thread] [next in thread]
List: sr-users
Subject: Re: [SR-Users] Info: converting dokuwiki content to markdown files
From: Seven Du <dujinfang () gmail ! com>
Date: 2022-05-12 13:01:34
Message-ID: CAJs+-5rprt7qcZG-3GQ08aGoRZEjyc-=G08G-OD6KCGQ0u_Dww () mail ! gmail ! com
[Download RAW message or body]
[Attachment #2 (multipart/alternative)]
more on mdBook, Nav Summary page doesn't work well without
https://github.com/rust-lang/mdBook/issues/167
So only mkdocs and pandoc left.
On Thu, May 12, 2022 at 5:06 PM Daniel-Constantin Mierla <miconda@gmail.com>
wrote:
> 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@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/
>
>
> __________________________________________________________
> Kamailio - Users Mailing List - Non Commercial Discussions
> * sr-users@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
>
--
Work: http://xswitch.cn
Community: http://rts.cn
About: http://about.me/dujinfang
[Attachment #5 (text/html)]
<div dir="ltr">more on mdBook, Nav Summary page doesn't work well without <a \
href="https://github.com/rust-lang/mdBook/issues/167">https://github.com/rust-lang/mdBook/issues/167</a> \
<div><br></div><div>So only mkdocs and pandoc left.</div></div><br><div \
class="gmail_quote"><div dir="ltr" class="gmail_attr">On Thu, May 12, 2022 at 5:06 PM \
Daniel-Constantin Mierla <<a \
href="mailto:miconda@gmail.com">miconda@gmail.com</a>> wrote:<br></div><blockquote \
class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid \
rgb(204,204,204);padding-left:1ex">More on emoji support with mkdocs: I installed the \
extensions but they<br> seem to point to CDN sites with links to svg/png images. This \
is also<br> done by github when browsing the files in the repo (they point to \
their<br> CND server), but I think it's not the optimal solution for the \
variant<br> to be stored on <a href="http://kamailio.org" rel="noreferrer" \
target="_blank">kamailio.org</a>, because every time someone loads it from<br> our \
website, the emojis are downloaded from the remote CDN servers (can<br> be slower, \
privacy concerns, ...).<br> <br>
Apparently it works to paste the UTF-8 character code for the emoji in<br>
the md file and then all looks good in github repo and<br>
mkdocs/mdbook/pandoc output. Therefore I think this is better to do.<br>
<br>
For now, my solution for getting the UTF-8 code for a specific emoji is<br>
to select & copy the character from another file having it. For example<br>
open in browser:<br>
<br>
* <a href="https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md" \
rel="noreferrer" target="_blank">https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md</a><br>
<br>
Then do "View source", search in it for the emoji you want, e.g.:<br>
":warning:" and you should find something like:<br>
<br>
<td align="center"><g-emoji class="g-emoji" \
alias="warning"<br> fallback-src="<a \
href="https://github.githubassets.com/images/icons/emoji/unicode/26a0.png" \
rel="noreferrer" target="_blank">https://github.githubassets.com/images/icons/emoji/unicode/26a0.png</a>"> \
️</g-emoji></td><br> \
<td><code>:warning:</code></td><br> <br>
The character looks like a small image, respectively the yellow triangle<br>
with exclamation before the end tag </g-emoji>. Select it, copy and<br>
paste in the md file where you want to use it.<br>
<br>
Cheers,<br>
Daniel<br>
<br>
On 11.05.22 14:17, Daniel-Constantin Mierla wrote:<br>
> On 11.05.22 14:11, Daniel-Constantin Mierla wrote:<br>
>> I played a bit with mkdocs on kamailio-wiki files and published the html<br>
>> output at:<br>
>><br>
>> * <a href="https://www.kamailio.org/wikidocs/" rel="noreferrer" \
target="_blank">https://www.kamailio.org/wikidocs/</a><br> > Following up: I \
noticed mkdocs does not support emoji (which I thought<br> > of using to highlight \
paragraphs, notes, etc.), but there seem to be<br> > extensions for it.<br>
><br>
> Cheers,<br>
> Daniel<br>
><br>
><br>
>> Some internal links may not work because I noticed warnings when mkdocs<br>
>> was building the html pages, I will review and fix when I get a chance.<br>
>><br>
>> The kamailio-wiki gtihub repo has now a Makefile that enables building<br>
>> html files using pandoc or mkdocs. Maybe someone can contribute support<br>
>> for using hugo or other static site generator, then we can decide in the<br>
>> community which result is better to publish on the website.<br>
>><br>
>> Cheers,<br>
>> Daniel<br>
>><br>
>> On 10.05.22 16:31, Daniel-Constantin Mierla wrote:<br>
>>> Thanks for the useful details about hugo!<br>
>>><br>
>>> For the records, in the past we used the mkdocs for a couple of<br>
>>> tutorials, like the one for KEMI framework or install guidelines, \
eg:<br> >>><br>
>>> * <a \
href="https://www.kamailio.org/docs/tutorials/devel/kamailio-kemi-framework/" \
rel="noreferrer" target="_blank">https://www.kamailio.org/docs/tutorials/devel/kamailio-kemi-framework/</a><br>
>>><br>
>>> Built from:<br>
>>><br>
>>> *<br>
>>> <a href="https://github.com/kamailio/kamailio-docs/tree/master/kamailio-kemi-framework" \
rel="noreferrer" target="_blank">https://github.com/kamailio/kamailio-docs/tree/master/kamailio-kemi-framework</a><br>
>>><br>
>>> But I can't say I am that familiar with it to assert if it is the \
best<br> >>> one for the wiki, which has lot of content and some pages could \
end up<br> >>> with large ToC (e.g., the cookbooks for core, variables, \
...).<br> >>><br>
>>> Anyhow, let's have it in the list and see if we get more feedback \
or<br> >>> other suggestions from the community.<br>
>>><br>
>>> Cheers,<br>
>>> Daniel<br>
>>><br>
>>> On 10.05.22 13:01, Greg Troxel wrote:<br>
>>>> Daniel-Constantin Mierla <<a href="mailto:miconda@gmail.com" \
target="_blank">miconda@gmail.com</a>> writes:<br> >>>><br>
>>>>> Ideally it is an app that can run on or behind a http \
server/proxy and<br> >>>>> serve html pages generated from the .md \
files directly from the folder<br> >>>>> with the clone of the github \
repo. But maybe I ask too much and adapting<br> >>>>> the wiki \
structure for a static site generator from .md files is enough<br> \
>>>>> or even better.<br> >>>> I have been slowly \
converting my own content to hugo. It's a very<br> >>>> \
straightforward static site generator, and it runs very quickly.<br> \
>>>><br> >>>> It also has a built-in webserver, and by \
default it watches the content<br> >>>> files and provides the built \
website on port <a href="http://127.0.0.1:1313" rel="noreferrer" \
target="_blank">127.0.0.1:1313</a>. This is<br> >>>> intended for \
previewing while editing - once you save a file the browser<br> >>>> \
window gets the new content in under a second.<br> >>>><br>
>>>> So if you either make hugo use your layout, or adapt to hugo's \
idea of<br> >>>> layout (which is quite sane), then not only can bits be \
pushed to a<br> >>>> server, but "hugo server" will make them \
available.<br> >>>><br>
>>>> So if I were tackling this, of all the options listed, I would \
lean<br> >>>> strongly to hugo.<br>
>>> -- <br>
>>> Daniel-Constantin Mierla -- <a href="http://www.asipto.com" \
rel="noreferrer" target="_blank">www.asipto.com</a><br> >>> <a \
href="http://www.twitter.com/miconda" rel="noreferrer" \
target="_blank">www.twitter.com/miconda</a> -- <a \
href="http://www.linkedin.com/in/miconda" rel="noreferrer" \
target="_blank">www.linkedin.com/in/miconda</a><br> >>> Kamailio Advanced \
Training - Online: June 20-23, 2022<br> >>> * <a \
href="https://www.asipto.com/sw/kamailio-advanced-training-online/" rel="noreferrer" \
target="_blank">https://www.asipto.com/sw/kamailio-advanced-training-online/</a><br> \
>>><br> >> -- <br>
>> Daniel-Constantin Mierla -- <a href="http://www.asipto.com" rel="noreferrer" \
target="_blank">www.asipto.com</a><br> >> <a \
href="http://www.twitter.com/miconda" rel="noreferrer" \
target="_blank">www.twitter.com/miconda</a> -- <a \
href="http://www.linkedin.com/in/miconda" rel="noreferrer" \
target="_blank">www.linkedin.com/in/miconda</a><br> >> Kamailio Advanced \
Training - Online: June 20-23, 2022<br> >> * <a \
href="https://www.asipto.com/sw/kamailio-advanced-training-online/" rel="noreferrer" \
target="_blank">https://www.asipto.com/sw/kamailio-advanced-training-online/</a><br> \
>><br> > -- <br>
> Daniel-Constantin Mierla -- <a href="http://www.asipto.com" rel="noreferrer" \
target="_blank">www.asipto.com</a><br> > <a href="http://www.twitter.com/miconda" \
rel="noreferrer" target="_blank">www.twitter.com/miconda</a> -- <a \
href="http://www.linkedin.com/in/miconda" rel="noreferrer" \
target="_blank">www.linkedin.com/in/miconda</a><br> > Kamailio Advanced Training - \
Online: June 20-23, 2022<br> > * <a \
href="https://www.asipto.com/sw/kamailio-advanced-training-online/" rel="noreferrer" \
target="_blank">https://www.asipto.com/sw/kamailio-advanced-training-online/</a><br> \
><br>
-- <br>
Daniel-Constantin Mierla -- <a href="http://www.asipto.com" rel="noreferrer" \
target="_blank">www.asipto.com</a><br> <a href="http://www.twitter.com/miconda" \
rel="noreferrer" target="_blank">www.twitter.com/miconda</a> -- <a \
href="http://www.linkedin.com/in/miconda" rel="noreferrer" \
target="_blank">www.linkedin.com/in/miconda</a><br> Kamailio Advanced Training - \
Online: June 20-23, 2022<br>
* <a href="https://www.asipto.com/sw/kamailio-advanced-training-online/" \
rel="noreferrer" target="_blank">https://www.asipto.com/sw/kamailio-advanced-training-online/</a><br>
<br>
<br>
__________________________________________________________<br>
Kamailio - Users Mailing List - Non Commercial Discussions<br>
* <a href="mailto:sr-users@lists.kamailio.org" \
target="_blank">sr-users@lists.kamailio.org</a><br>
Important: keep the mailing list in the recipients, do not reply only to the \
sender!<br> Edit mailing list options or unsubscribe:<br>
* <a href="https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users" \
rel="noreferrer" target="_blank">https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users</a><br>
</blockquote></div><br clear="all"><div><br></div>-- <br><div dir="ltr" \
class="gmail_signature"><div dir="ltr">Work: <a href="http://xswitch.cn/" \
target="_blank">http://xswitch.cn<br></a>Community: <a href="http://rts.cn/" \
target="_blank">http://rts.cn</a><div>About: <a href="http://about.me/dujinfang" \
target="_blank">http://about.me/dujinfang</a><br><div><div><div><br></div></div></div></div></div></div>
__________________________________________________________
Kamailio - Users Mailing List - Non Commercial Discussions
* sr-users@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
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic