Hi ,
I was looking for the use of Pandoc.And I came to note following point
(please correct me if I am wrong):
Advantages :
1.It provide a variety of option for converting document from one format to
another.
2.Easy to use for creation of HTML from markdown.
Disadvantages:
1.Create a plane and simple HTML corresponding to the markdown.
2.Don't add basic functionality to the created HTML like side bar and
navigation bar(unless added to each markdown).
3.Search bar will be difficult to implement.
Suggestions/Requests:
1.Using Pandoc for conversion for formats other than HTML (which is
important because going to be displayed on FreeType website directly).
Alternate:
1.Using Jekyll for website from markdown. Sample repository(
https://github.com/tomjoht/documentation-theme-jekyll) and live webpage(
https://idratherbewriting.com/documentation-theme-jekyll/) . But problem
lies with markdown writing as it uses a slightly different syntax for
differentiating various component.
2.Or another Jekyll this theme(
https://github.com/aksakalli/jekyll-doc-theme) live at
https://aksakalli.github.io/jekyll-doc-theme/. It uses a header table to
specify the type of page that can be easily manged with the use of a simple
script which only need to used along Pandoc when converting to any other
format.
*3.MkDocs : Which I personally consider best and used by Keras to host its
documentation and info of library(live at https://keras.io/
<https://keras.io/>). Keras docs
repository(https://github.com/keras-team/keras/tree/master/docs
<https://github.com/keras-team/keras/tree/master/docs>) because it preserve
the structure/view which is required for conversion to other format.*
*P.S. :* These are only for base reference of alternative, we can work on
own custom theme and syntax to maintain for markdown.
I am still working on learning more about Pandoc and it's substitute ;).
Looking forward for the feed back from community :).
Thanks & Regards,
Ankit
_______________________________________________
Freetype-devel mailing list
Freetype-devel@nongnu.org
https://lists.nongnu.org/mailman/listinfo/freetype-devel
