Hosting better-docs documentation on a website that is not Github Pages? - jsdoc

I was wondering if anyone has found a good solution for publishing their jsdoc/better-docs documentation on a website that isn't Github Pages (for privacy concerns)? I've built an api to retrieve the html files from the documented project but it loses the better-docs templating when it's no longer within the same project. Any recommendations would be appreciated. Thanks!

Github is pretty secure and you can also make everything private if needed.
I would recommend Github, if not you can always opt for any alternatives like:
GitLab
SourceForge
BitBucket
Launchpad
you can read here more: https://itsfoss.com/github-alternatives/

Related

How can we integrate Jekyll to allow "not technical " to create and edit posts within an organization?

We maintain a website that contains a blog.
This blog is generated through Jekyll. My problem is that I need another internal department to edit/create posts, but they have no idea about git or any command line.
I was wondering if any plugin / CMS framework could be implemented around Jekyll to allow such thing.
I've already read about prose.io, but I don't want to run through GitHub Pages since the blog is host in the same place as the website it refers to.
Thank for any help !
You can use CloudCannon.com for easy editing and let CloudCannon sync your blog through FTP with your host. The result will be: the same hosting environment and a very user friendly CMS, which is designed specifically for Jekyll integration.
PS. You can use the free plan.

difference between github gist and wiki

What is the difference between a GitHub gist and GitHub wiki page?
I have steps that I want to share with the GitHub community so they can modify their profile settings. But unsure which one to use
Gist is an independent service with some really nice metadata including when it was last active and versioning, just like GitHub proper. Wikis don't check into git as a version control system.
Supporting docs:
About wikis
About gists

Are there any GUI/WYSIWYG CMS editor based on Jekyll?

I find Jekyll to be very easy and useful to maintain static html sites and blogs, especially along with GitHub pages. Wanted to know if there are any Static site generators or CMS which helps in maintaining Jekyll sites with live preview, inline editing, layout management, file management etc.
There's an emerging market of "headless CMS" services that let you (or other writers) edit content through a web interface, and then access this content via an API. Most have webhooks that could be used to trigger regeneration of the static site when the content stored in the CMS is changed. Libraries for jekyll integrations already exist for these platforms.
List of headless CMSes:
Prismic (jekyll library)
Contentful (jekyll library)
Osmek
Storyblok (jekyll integration)
others
A few cool products fit the bill here:
CloudCannon
Siteleaf
Forestry.io
DatoCMS
Netlify CMS
jekyll-admin
Most of them sync directly with Git so devs can push directly on the repo, and non-techie users indirectly do the same by saving content (which trigger builds) in simpler UIs.
I personally like CloudCannon for its easy, more "visual" approach to editing stuff for non-technical folks (one of our dev wrote a full tuts on using CC + Jekyll for a multilingual site, should it be helpful).
Netlify CMS' open source approach is pretty neat too. The CMS is basically a react app you inject in any project.
Happy coding.
I have found these solutions:
http://www.siteleaf.com/
http://cloudcannon.com/
The second seems to be more promising to me. We basically want to develop the jekyll templates on our side, but want to have the possiblity for non-coders to edit the content online.
If you don't want to pay and you are okay with hosting a solution or do the editing offline, then you could try out this one: https://github.com/jekyll/jekyll-admin (Although I haven't tried it, but if you do, please share your experiences with me.)
I just finished with a simple editor for the same. You can find it on github here. It is still in initial release stage but it does come with live preview for editing posts on jekyll and managing them.
I'm searching for the same, as all Static site generators I found require Markdown knowledge which isn't suitable at all for my clients.
I found this great CMS (Kinda!) https://sitecake.com/
Still don't know how to manage collections with it, say listing of few products with lightbox details, but I believe it is possible.

Create gitbook from github wiki pages

I've a lot of documentation in github wiki. I would like organize it and create a book out of it. When ever I update the wiki, the book should be updated. Is this possible ?
Welcome to Gitbook. This service might help you.
https://docs.gitbook.com/integrations/github/import-of-github-wikis
This service as far I read doesnt support github wiki directly.
However because github stores wiki as a seperate repository with reponame.wiki.git, you should be able to import this github repo into gitbook.

Travis CI with GitHub Pages / Linkchecker

I am hosting pages on GitHub Pages. These use Jekyll, but that shouldn't matter.
Since we have source code management for the web pages and even a publishing and hosting... why not add CI!
Is there a best practice for implementing a link checker using Travis CI scenario. Also, practically, is this the "right" thing to do since may use a lot of resources?
Thank you!
Check the official document of Jekyll.
(http://jekyllrb.com/docs/continuous-integration/)