I'm using gitlab to manage my repositories which has been quite pleasant so far. However the wiki could use a fair amount of improvement IMO.
It's really annoying when you already have documentation that you simply want to add to the wiki. Translating a table or pdf to gitlab flavored markdown can be time consuming and non-trivial.
My question is two-fold.
Has anyone had luck embedding files (specifically pdf's) into their github/gitlab wiki? This should definitely be possible on gitlab but is their an easy way to do it? I have a documentation repo set up, it would be awesome to embed files linked from the documentation repo.
If not embedding files into the pages. How do you efficiently translate a document to gitlab flavored markdown?
Had the same issue and landed here, maybe this helps somebody.
I didn't find a way to embed the .pdf into a page but what I did was to add the .pdf to the wiki folder (like a normal page). Initially this didn't show up in the sidebar nor was it searchable from Github.
It is possible however to link it directly from other pages or a custom sidebar (see for example osquery's wiki for a nice sidebar). Clicking on the link allows you to download the .pdf (didn't find a way to preview it in the browser)
It is possible that such action type is not allowed only in cloud gitlab version, cause gitlab-gollum lib documentation describes it so:
[[Gollum|gollum.pdf]]
I use Gitlab (self hosted) capabilities to render MarkDown pages regularly for documenting my projects.
The best way to copy paste html or pdf documentation and translate into perfectly formatted MarkDown is to use Typora. Typora has these very useful capabilities:
Support for Gitlab TOC rendering (i.e. [[_TOC_]])
copy and paste from HTML pages to MarkDown
upload of images
IMO is very easy to use for documentation with GitLab.
Related
It is almost 3 days that I am working on finding a solution to display the images in my Google cloud repository.
I did the same on bitbucket account and it works fine, but when I push everything into the google cloud repository the image does not show up in my README.md file.
I do not have any nested folder and all the files are placed into the root.
bellow you can find the syntax I used in my markdown file:
None of them are working, I found another post on stack overflow that Google cloud repositories are a kind of bare repository. does it means there NO way to do that?
Could you please help me out with this?
I think this is not possible. Such a feature is not listed in the official documentation. Too bad are not a lot of people complaining about this. The only thing I could find was the following:
The only option is mirroring to Github or Bitbucket, but I think that is not what something you want. You could also just use Github instead of Cloud Repositories, which now integrates nicely with the google cloud platform, specifically Cloud Build.
I have a pdf file generated by latex which has many equations and what not. I want to use this pdf as the readme.md file in my github repo. How can I do this?
Alternatively, is it possible to directly integrate the tex file in github and use that as a readme instead of the pdf version? Does github allow any integration with latex syntax as does gmail for example?
You cannot import PDF as Readme, but I also don't see the point as it support the wonderful MD Language which can be seen easily with any device (also mobile).
I have fixed the equations problem by using images. There is a nice website for that: http://mathurl.com/
Just type your latex equation and click "Make Math url" (bottom left button), the copy paste the image link (in red).
I have used it in the wiki of github (but it should work the same with readme.md): https://github.com/scholi/pySPM/wiki/Mass-calibration
Enjoy!
A Google search yields the GitHub page for Google Test. I'm finding many links around the web to https://github.com/google/googletest, which now redirects to the GitHub page. The GitHub project has an overview and a readme.md, which mostly explains how to build Google Test.
Where is the official user documentation for Google Test, or some equally useful, comprehensive documentation?
The documentation is in the GitHub repo, as .md files in the googletest/docs directory. Start with Primer.md. And then you can look at more advanced topics.
Shameless plug: Because it's annoying to go through the unrendered md files locally and use the difficult to navigate around md files on github, I publish the google test docs (https://gunslingerfry.github.io/google-test-docs) using mkdocs with a very minimal addition of an index.
I'm searching for a good PDF viewer for Joomla, the problem is when there is a module in an article all the PDF viewers I tried so far show: {loadposition myposition} in place of that module.
Does anybody know a PDF viewer that will show the module.
I would also like it to have a header and footer option.
Thx.
I suspect that your extensions 'might' not be the sole source of your troubles.
Have you installed "Modules Anywhere" from nonumber.nl?
I recommend you try that first before assuming that the problem lies in your extensions.
Here is the appropriate link: http://www.nonumber.nl/extensions/modulesanywhere
Install it, and make sure the editor plugin is also installed and enabled (Modules Anywhere may perform these steps upon installation), then open up the content item you wish to inject your module into and use the module selection tool provided to you by the editor plugin.
After you perform this test, you can more reliably assume that your PDF related modules are the culprits.
Good luck!
I'd like to use docs generated by godoc to be served statically (on App Engine) for a project I created. I see that godoc starts a server and apparently the package docs are all generated dynamically. But is there a workaround to save the docs to the filesystem or what other options do I have?
If you're using GitHub, there's a pretty nice project for this already: http://gopkgdoc.appspot.com/
Documentation's at the bottom of the page. It's open source and with a little effort, you may be able to get it to generate documentation from non-GitHub services.