Hi, Nirojan,
How about add doc website under http://apisix.apache.org/?

Thanks,
Ming Wen, Apache APISIX & Apache SkyWalking
Twitter: _WenMing


Zhiyuan Ju <[email protected]> 于2020年6月17日周三 上午8:02写道:

> Wow, thanks for your effort! Please keep syncing from the APISIX repository
> ASAP.
>
> Best Regards!
> @ Zhiyuan Ju <https://www.shaoyaoju.org/>
>
>
> Nirojan Selvanathan <[email protected]> 于2020年6月17日周三 上午2:25写道:
>
> > Hi All,
> >
> > APISIX docs are maintained in markdown format. I've tried to migrate the
> > docs with minimal effort to a documentation platform. I've tried out the
> > following markdown to site generation platforms.
> >
> > - Docsify <https://docsify.js.org/#/quickstart>: Needs minimal effort
> and
> > looks elegant.
> > - Docusaurus <https://docusaurus.io/> from Facebook: Language
> > translation for v2 is still under development, but also elegant and easy
> to
> > use.
> >
> > Due to language support, I've generated the docs based on Dosify
> > (Inprogress).
> >
> > English Docs: https://sshniro.github.io/apisix-docsify/#/README
> > CN Docs: https://sshniro.github.io/apisix-docsify/#/zh-cn/
> > Repository: https://github.com/sshniro/apisix-docsify
> >
> > The document can be structured into 5 mains parts:
> > - Introduction
> > - Getting Started
> > - Core (Architecture, Installation)
> > - Plugins (Security, Authentication, etc)
> > - Admin API
> >
> > Changes Required.
> > - Create a short introduction page (Current ReadMe is long for the
> > introduction)
> > - Remove the table of content from each markdown file. (Docsify by
> default
> > shows this in the navbar)
> > - Create separate folders for different languages (CN etc)
> > Apart from the above the current content and structure will remain the
> > same.
> >
> > I would like to hear the opinion regarding using the above approach. If
> the
> > community is okay with this, I can create a PR for the modifications. The
> > docs can be deployed along with the apisix website as it bundles as a
> > static site.
> >
> > --
> > Best Regards,
> > S.Nirojan
> > Linked-in <https://www.linkedin.com/in/niroselva/>
> >
>

Reply via email to