I am using sphinxcontrib.confluencebuilder to publish my Python documentation to Confluence cloud.
It creates labeled pages with the header/footer macros I need but it does so in the old Editor V1 format.
I haven't been able to find a config setting to tell it to use the Confluence V2 editor format. Is there a way to do so?
Also, the various extensions (myst-parser, m2r2 etc) for processing MD files work fine when outputting HTML but don't seem to take effect when publishing to Confluence. I'm using shell scripting and awk to convert MD to RST files but is there a better way?
Eventually this is going to run within a GitHub workflow.
The extension as of v2.x now supports the "v2" (Fabric) editor format. This can be configured using the confluence_editor option:
confluence_editor = 'v2'
There are limitations when using the editor, which are outlined in the extension's documentation and demonstration pages.
Disclosure: I am a maintainer for the Atlassian Confluence Builder for Sphinx extension.
Related
Does the ace editor have an online URL to the ace scripts for specific use cases such as the following:
A project always wants to use the latest version
A project wants to use a specific previous version
A project wants to test for bugs, features or regressions between versions (expects versioning online ace_1.0.0.js, ace_1.1.0.js, etc)
A component was created to wrap the ace editor. The component author does not want to maintain a separate local branch of ace so he wants to point to an online source so his examples work out of the box.
For versioning example, I think Google maps provide a parameter but a file name also works.
There are multiple cdns hosting ace:
https://cdnjs.com/libraries/ace
http://www.jsdelivr.com/projects/ace
https://unpkg.com/ace-builds#1.2.6/src/ https://unpkg.com/ace-builds/src/
gh pages https://ajaxorg.github.io/ace-builds/src/ace.js and https://rawgit.com/ work as well.
There are lot of Swagger related codegens to convert a YAML to HTML file , but is there an eclipse plugin available which can open or convert a YAML to HTML ?
I have searched in multiple places but there's no place where we can find such a plugin .Plugins like Yedit help seeing a YAML in colour syntax form but not as a HTML ?
You might want to take a look at RepreZen API Studio, available as a standalone desktop application or as an Eclipse plugin.
It includes swagger-codegen and other open source generators, which can create various forms of HTML documentation from your YAML-formatted Swagger-OpenAPI spec. Code generation is fully integrated into the IDE, but can also be run from the command line or CI/CD automated builds.
To clarify, there's no HTML "equivalent" of a Swagger-OpenAPI spec, or any other form of YAML. So it's not a simple matter of converting one file format to another. But there are various components that render a machine-readable OpenAPI spec, in YAML or JSON form, in a user-friendly HTML documentation format, often with integrated sandbox testing.
One of these is Swagger-UI, and it's included in the HTML formats that are supported by RepreZen API Studio. I hope that helps.
I wrote a Javascript (jQuery) plugin. Now I want to write a documentation site for it. Is there a good tool to create such a site out of some offline file formats or works like a CMS?
I know this answer has been asked before, but the last answers are from 2011. Is there anything new that does an awesome job in writing documentation?
There are a few new tools for generating websites or blogs from code/directory.
Bootstrap v3 just switched to jekyll for documentation. jekyll knows how to process Markdown or Liquid (markdown flavours)
Grunt.js is also used for all sorts of automated task. One of these being documentation generation. Search their plugin list for doc
assemble.io is another tool for generating documentation pages
I'll extend if I bump into others. I am not sure if this is exactly what you need, but they are general purpose so I am sure a jQuery plugin can fit in.
There are many libraries for transforming markups like reStructuredText and markdown to HTML. I have some users who are familiar with the markup used in Atlassian's Confluence wiki product, which is unfortunately proprietary -- is there any open source compiler for the confluence wiki markup format, or possibly something that would transform it to an intermediate format?
I think Confluence uses the Textile markup format. I have used over the last few years a rails application that used the gem RedCloth to do the transformation, and I could switch between the 2 formats. I never checked if it is complete interchangeable, however.
You could check for yourself if it is sufficient at Try RedCloth.
Anyone know of a wiki or wiki plugin that generates a PDF file or CHM file that spans the entire wiki?
I would like to have control of the table of contents.
I would like the internal and external links to work.
Ideally allow for tweaking the output template, but that is not a deal-breaker.
I want to generate content using WIKI syntax and mindset (lots of cross-links etc), but ship the content in PDF, CHM or an embedded application form. Something friendlier than installing the wiki software on the enduser machine...
XWiki does this out of the box.
The MediaWiki PDF Export extension allows you to select a group of PDF pages. I've not installed it yet, so unsure if it's easy to use that feature to select all the pages.
Confluence lets you choose pages when you export to PDF a space
But you can't customise a lot the PDF
You can customise it slightly through a theme (based on velocity)
Sphinx (https://www.sphinx-doc.org) is a fairly nice tool for generating HTML (or CHM) and PDF documentation, with wiki-like syntax. It is not a wiki; you can't edit through the web and generating HTML requires a build process. Still, it is pretty nice, with cross-references, fairly simple markup, and (in the HTML output) a search engine implemented in JavaScript with no server-side dependencies beyond static file hosting. Sphinx was developed for the new version of the Python documentation and is pretty themable; for example, the GeoServer project (which I work on, excuse the shameless plug) is using Sphinx with a custom theme for the new version of their user and developer manuals.
JIRA (http://www.atlassian.com/software/jira/default.jsp) is your geeky wet dream in terms of control; it exports to PDF (amongst other) and you can have complete control of pages, TOC and other aspects, although expect some complexity to set it up.
Microsoft has an HtmlHelp Authoring tool that can create chm files from html files.
If you need the help files both on the web and within deployed applications, generating the help from the same files used on the web could be a great solution. If the help site was created using asp.net (ie database driven) it might be worth using basic styles and creating a tool to generate html files by reading in the served out pages?
Have a look at: http://msdn.microsoft.com/en-us/library/ms524239(VS.85).aspx
I guess one could also additionally then create a PDF from the Html pages?