If I have an html file somewhere in the same folder as a markdown document, is there any way to embed the entire file inside a markdown document, so that the html will be rendered correctly (not just the code displayed)?
Markdown doesn't support includes out-of-the-box. You need to use one of the existing flavors or static site generators that support markdown or/and HTML inclusions. For example, DocFX
You can't include other Markdown files in Readme (Readme is usually Markdown file). You can use the "Quote" (See example below)
This is Quote
> This is Quote
You can see my Markdown guide here
Related
I'm trying to create a github.io profile.
May I know the difference between of .md .html .rmd files?
For example, I see the same file name with different filetypes like
Readme.md vs Readme.html XXX.rmd vs XXX.html
github.io (aka Github pages) can create a website from either
html with optional css
Markdown files (.md and .rmd)
A combination of the above
It uses a set of tools called Jekyll and kramdown to translate markdown files into html to be displayed as part of the website.
Markdown files are a file format generally used for producing documentation in github on similar websites, and has a mopre streamlined syntax for that purpose than html. You can try it out at https://stackedit.io
The use of markdown for Github Pages is however completely optional and you may use only html if you wish. You can follow the guide at https://jmcglone.com/guides/github-pages show you how to make a github pages site with html. Stop when you get to the section Using Jekyll with GitHub Pages if you don't wish to incorporate any markdown.
I have installed RMarkdown package in my R-Studio and I want to knit into HTML format. After knitting any .rmd file (including the default code created after starting a new Rmd file), the output html file does not include any markdown styling. See the picture of the generated html file on my computer here:
As you can see for example, the font is set as plain Times New Roman and also the way the dataframes are displayed does not look like the usual markdown-style.
Please, how can I get the HTML file styled as an usual markdown file?
Note: I did not modify the markdown.css file in the library's folder.
Thanks in advance!
I have two markdown documents; A.md and B.md. The A document includes a link to B using the tag (B)[B.md]. That link works great when navigating markdown documents.
Now I want to export all my markdown files to HTML as part of a release documentation package. The issue is that in the exported HTML the link points to B.md when what I really want it to point to is the newly exported B.html.
Anyone have any ideas on how to automatically update links?
I am currently using pandoc to export to html because it has a command line interface and therefore I can script its execution.
Right now my workaround is to update A so that it links to the html version of B, [B](b.html). This allows my html exported documents to work but breaks navigation within the original markdown files. Alternatively I could replace the links myself as part of the script but that sounds painful.
What I am really looking for is a way to export a collection of markdown files as a standalone documentation package.
You can use a simple Lua filter to change the link from .md to .html:
-- file: change-links.lua
function Link (link)
link.target = link.target:gsub('.md$', '.html')
return link
end
Adding the parameter --lua-filter=change-links.lua to your call to pandoc should be all that is needed.
See also this related question.
For most of my project's documentation I prefer a standard sphinx layout. However for the landing page I would prefer to use custom HTML/CSS/JS without any of the layout, TOC, or sidebars of the normal sphinx site. Is there a way to include a raw HTML standalone page in a sphinx-generated website in a way that completely disregards the normal layout of the rest of the site?
As a counter example I know that I can include raw HTML bits into a page using the following (see also this question)
.. raw:: html
:file: myfile-html
However this just embeds a file within the normal layout. I would like to have a completely standalone HTML page.
I just ran into this problem myself, and the way I solved it was to simply include the html file in my source/_static folder, then refer to it with a relative link.
So if source/_static/my_standalone.htm is the path where I have my non-generated HTML file, and the .rst file where I want to type my link is at source/otherfolder/index.rst, I write it like this in my rst:
Link to my non-Sphinx HTML file
===============================
To get to my standalone, non-generated HTML file,
just `click here <../_static/my_standalone.html>`_ now!
I have a rather nasty, huge HTML document that I converted to markdown.
When I do the usual layout and view the .md file in GitHub via preview tab, it looks fine. However, when I serve it and view it on my actual site, it renders all the HTML tags.
I have tried using different markdown interpreters like redcarpet versus kramdown, to no avail.
How do I get a good markdown rendering of HTML similar to the GitHub behavior?
Link to repo (notice the clean GitHub Flaovred markdown)
This is not a markdown but a html document.
Rename it to test.html
Remove html and body tags
give it a :
---
layout: page
title: Test
permalink: /test2/
---
I've made a pull request that works to you repo.
Note: before pasting word html to the web you can clean it.