I am documenting a dart project. I generated HTML documentation with dartdoc. I don't want this HTML to be put in the project so I read this article:
Gitlab and HTML documentation about external wiki.
But I can't find this option in my GitLab, so I was wondering if it is still possible or if better solutions exist to implement HTML documentation in GitLab.
Or maybe there are some ways to convert the HTML into markdown to make it easier to put on GitLab.
External wiki settings are accessed at https://{your_gitlab_host}/{group}/{repository}/services/external_wiki/edit
Related
I am currently looking into static site generators.
I build a testing documentation site with Vuepress and am now fiddling with going into the live operation.
i don't want to publish my files to services (GitHub Pages, Netlify etc.) but I want to host it on my own server.
Generating static html sites everytime I add markdown pages or change the content is not an option.
Is there a way to host Vuepress (or maybe similar markdown generators) where I just need to upload the .md files and everything goes automatically?
There are two basic ways to use markdown as your website...
use a live server:
In this scenario, each request is processed by a program which retrieves the markdown text and does some pre or post processing (templateengine, formatting etc).
This could be a simple CGI script, a web framework or a custom server.
use a static site generator:
You process the markdown on your lokal machine and generate static html files, which are uploaded and served by a web server.
To answer your question whether or how you can use vuepress:
There are multiple possible ways, depending on your current setup.
If you only have some webspace, than you have to upload prerendered html files (or using another framework).
If you have a virtual server, than you can automate the build/rending process by using scripts, e. g. with file watchers.
Note to GitHub:
Even if you said, that you don't want to use GH... If you only want to hide the markdown files, you can create a private repository and use GH Actions as CI/CD pipeline.
Unfortunately Stackoverflow is not for software recommendation, so for alternatives to vuepress have a lookt at Software Recommendations.
So I know that GitLab pages can be employed to generate a static website from a project's repository. What I'd like to do however, is generate a static site from a project's wiki, which is a separate repository.
I also know that I could hook a static site generator to the webhook event for notifying wiki changes. I am trying to work out if this obvious (to me) use-case was anticipated and made possible via GitLab's pages feature, which has a simpler set-up, or if I really do need to resort to webhooks.
So far as I can tell, it wasn't, and I do, but possibly there are ways which just haven't been well described anywhere I can find.
Finally: the reason I want to do this is, GitLab's wiki seems to have a UI tailored to make it work more like a wiki than the repository's UI. This will I hope make it more useful/less hostile to the potentially non-technical users I foresee using it.
I don't think this feature is available yet, even though it would definitely be very useful.
You could try the following workaround:
Set up your project wiki's repository as an external repository.
https://docs.gitlab.com/ee/ci/ci_cd_for_external_repos/
This will setup repository mirroring, enabling automatic pull updates from your wiki repository to a new regular GitLab project repository. You can then use the regular GitLab CI and GitLab Pages feature to generate a static site from the wiki.
More information about repository mirroring:
https://docs.gitlab.com/ee/workflow/repository_mirroring.html
Example Project (Edit)
I have now made a basic (open-source) example for doing this, it actually works very well, you can browse its source and have a look at the wiki at https://gitlab.com/tkainrad/wiki2docs.
The generated site is located at https://tkainrad.gitlab.io/wiki2docs
You might even find that having a layer between your Wiki and the actual live site is useful.
This workaround together with GitLab Pages provides a lot of possibilities, and enables completely free hosting of wiki or documentation sites, while maintaining an easy EDIT-interface for non-technical contributors.
YUI user guides are really nice, please visit http://yuilibrary.com/yui/docs/event/ for example,I just wanna write documents like that. My question is: these documents were generated by some tools like Dockbook,Sphix or written by hand?
The YUI User Guides are generated from Mustache templates using a tool called Selleck. Selleck is a Node.js tool that generates pages from different templates based on the information provided in a component.json file and a predefined folder structure. One of the coolest features of this tool is that it has a --server mode which runs a local web server in which you can see the changes you made live by just refreshing the page.
You can check it out at http://yui.github.com/selleck/.
I really appreciate Github's website look & feel and I would like to "clone" it on a admin tool I'm developing right now.
Does anyone knows if there's a Github Bootstrakp (just like Twitter bootstrap) or something similar? Perhaps a Github-like UI admin template ...
I found their Style Guide page (https://github.com/styleguide/) but wasn't able to get the css and javascript source codes.
Thanks a lot.
Github's ui is not open source as far as I know, however there is a FOSS clone called gitlabhq:
http://gitlabhq.com/
And the source is available on github:
https://github.com/gitlabhq/gitlabhq
There is https://github.com/primer/primer described as
CSS toolkit that powers GitHub's front-end design. It's purposefully limited to common components to provide our developers with the most flexibility, and to keep GitHub uniquely GitHubby. It's built with SCSS and available via NPM, so it's easy to include all or part of it within your own project.
I use Enterprise Architect from Sparx Systems for reverse-engineering URL class diagrams from my source code, and want to take this a step further by using the software to generate HTML API documentation of my code.
However I find the markup generated by Enterprise Architect to be full of Javascript, and I think I may have even spotted some VB Script in there. Want I want is a clean HTML-only template that I can use to produce simple markup that will work fine in all browsers.
I have tried to manually create this template using the template editor in Enterprise Architect 8, but find this cumbersome.
Does anyone know of an existing template I can use, or an easier way to generate a template without using the built in template editor?
The only way is to use JavaScript, you can turn it on by allowing XMLHTTPRequest in your browser. It works well in Firefox, Opera and IE.
EA HTML Template doesn't give much possibilities but you can modify everything thanks to JavaScript.
Another way is to export all diagrams as png or other image file and then manually create a static web page.