GitHub Community
Support for HTML READMEs (README.html) #109580
Replies: 11 comments 39 replies
-
|
If you prefer using plain HTML for your documentation and READMEs but need to host them on GitLab, there are a few options you can consider: Convert HTML to Markdown: You can use tools or online converters to convert your HTML documents to Markdown format. This would allow you to maintain your content in HTML locally but publish it on GitLab in Markdown format. There are various tools available that can help with this conversion process. Use GitLab Pages: GitLab Pages allows you to host static websites directly from your GitLab repository. You can create a static HTML website and host it using GitLab Pages. This way, you can write your documentation in HTML and have it rendered as a website hosted on GitLab. Embed HTML in Markdown: Although GitLab primarily supports Markdown for README files, you can still embed HTML within Markdown files. This can be done using HTML tags within Markdown syntax. While this may not be ideal for complex HTML documents, it could be a workaround for simpler HTML content within Markdown files. Browser Extension or Viewer: You can use a browser extension or viewer that allows you to preview Markdown files with embedded HTML directly in your browser. This would enable you to iterate on your documentation locally without needing to push changes to the repository each time. Choose the option that best fits your workflow and preferences for maintaining HTML documentation on GitLab. |
Beta Was this translation helpful? Give feedback.
-
|
Is GitLab distinct from GitHub? |
Beta Was this translation helpful? Give feedback.
-
@BugOfBugs, yes. I shouldn't need to tell you this, though, for a search on Google should reveal that they are distinct platforms operated by different companies. |
Beta Was this translation helpful? Give feedback.
-
|
Original referred to GitLab. |
Beta Was this translation helpful? Give feedback.
-
@BugOfBugs, I don't understand much of the strange syntax of that comment. However, I believe that I understand the gist. Irrespective, this isn't necessarily what should be discussed here. This thread is going rather off-topic. Thanks anyway. |
Beta Was this translation helpful? Give feedback.
-
|
Reply = @Ali-Cheikh = robot = it |
Beta Was this translation helpful? Give feedback.
-
|
Hi! Sorry, I meant Github, not Gitlab— copy-paste mistake, because I asked the same of Gitlab people 😅 The options you suggested are valid, but still, having native support is much better. And there's a precedent for multiple README formats already: Github supports Org Mode READMEs in parallel to .md ones. So why not add another format—the one that's already there in .md inline HTML—but with its own semantic file type? |
Beta Was this translation helpful? Give feedback.
-
@aartaka, what's the URI to that FR? |
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
Why? 🤨 |
Beta Was this translation helpful? Give feedback.
-
|
Use GitHub Pages: If your project has a corresponding GitHub Pages site, you can create a separate HTML file for your documentation and host it there. You can then link to this HTML documentation from your README. Preview Changes Locally: Instead of relying solely on GitHub's rendering, you can set up a local development environment to preview your changes before pushing them to the repository. This way, you can iterate on your documentation more quickly and efficiently. Consider Markdown Alternatives: While Markdown is the default format for README files on GitHub, there are some Markdown flavors that support more advanced features, such as HTML blocks or inline HTML. You could explore using these alternatives to see if they better suit your needs. Provide Clear Instructions: In your README, you can include clear instructions for users on how to view or interact with your HTML documentation. This could involve providing links to hosted documentation, instructions for previewing locally, or suggestions for tools that better support HTML. Submit Feedback to GitHub: If you believe that native support for HTML READMEs would be beneficial, you can submit feedback or feature requests to GitHub. While there's no guarantee that they'll implement this feature, expressing your needs and concerns can help drive future improvements to the platform. By exploring these options and possibly combining them, you may be able to mitigate some of the challenges you're facing with using HTML in README files on GitHub. |
Beta Was this translation helpful? Give feedback.
-
|
You are lazy to read long, boring, irrelevant lesson by Robot. Missed:
CoPilot would not write so. You may entertain us: ask CoPilot to reply to Robot. "Duel".
What is this? |
Beta Was this translation helpful? Give feedback.
-
You state a falsehood, @BugOfBugs. It states, verbatim, the undermentioned:
...instead of what you have quoted. Do not disparage another without indisputable evidence. Al else shall solely put you in poor stead. |
Beta Was this translation helpful? Give feedback.
-
|
My quote is sufficient, correct, to the point. CoPilot assured me of contrary: GitHub is diligent. Robots are useful: their stupidity raises our esteem. Perhaps should not report them... |
Beta Was this translation helpful? Give feedback.
-
@BugOfBugs, your ego outstrips both your orthographic competence and your technical knowledge. I understand well now why you were banned by @openssl. |
Beta Was this translation helpful? Give feedback.
-
|
Beware. Do not pander to aggressor... |
Beta Was this translation helpful? Give feedback.
-
I was unable to find where to submit feedback, thus I asked about HTML READMEs here. Any possibility you can point me to the right place? |
Beta Was this translation helpful? Give feedback.
-
@aartaka, this is the correct place. Heck, the "Provide feedback" option at https://support.github.com/request directs the user here. |
Beta Was this translation helpful? Give feedback.
-
@aartaka, a question for how to accomplish this exists at StackOverflow. It might be worth following. |
Beta Was this translation helpful? Give feedback.
-
|
No, this is not a spam. My original text was copy-pasted from Gitlab issue tracker, thus the confusion 🙈
|
Beta Was this translation helpful? Give feedback.
-
@aartaka, did you mean to respond to https://github.com/orgs/community/discussions/109580#discussioncomment-10473183? If so, it was directed at a different user. |
Beta Was this translation helpful? Give feedback.
-
|
Sorry, answering via email is terribly broken on Github. |
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
@Jhayricz06 and @Coding-Yasaru-Deneh, this isn't the place to discuss learning HTML. You're spamming those subscribed. |
Beta Was this translation helpful? Give feedback.
-
@Coding-Yasaru-Deneh, this Discussion is a feature request which specifically asks GitHub to implement |
Beta Was this translation helpful? Give feedback.
-
|
Hey @Coding-Yasaru-Deneh 👋 Just a quick reminder: if you're jumping in to help someone out, that's awesome! 😊 But please make sure you feel confident about the advice you're giving. It's super important to read the whole thread carefully to get the full context before responding. That way, we can all stay on topic and keep the conversation flowing smoothly. |
Beta Was this translation helpful? Give feedback.
-
@Coding-Yasaru-Deneh, profiles and standard organisations don't have account-wide discussions, so you shan't find one for @aartaka. If you expect one because https://github.com/orgs/community/discussions exists, it's because solely GitHub does. Discussions are repository-specific - they're about the content of the repository itself. If you want to discuss programming more generally, use Reddit or StackOverflow (although I advise you against the latter due to your current conduct - Reddit shall be more welcoming). I also rather doubt that they want to discuss HTML development with you - I think you might have misunderstood a previous comment of theirs. |
Beta Was this translation helpful? Give feedback.
-
@Coding-Yasaru-Deneh, glad to have been of assistance! Good luck in your endeavours. |
Beta Was this translation helpful? Give feedback.
-
|
To address the problem of using HTML in GitHub README files effectively, here are some potential solutions: 1.Use Markdown with Inline HTML: While GitHub primarily supports .md files for README, it allows inline HTML. You can structure your HTML content within a Markdown file for better compatibility. If you run into issues where GitHub is interpreting some lines as Markdown, try wrapping your HTML content in code blocks or using HTML comments () to prevent conflicts. 2.Convert HTML to Markdown: If you're working primarily with HTML, consider using an HTML-to-Markdown converter tool. This will allow you to maintain the visual structure of your content while converting it into a format that GitHub handles natively. Tools like Pandoc or specific browser extensions can assist with this conversion process. 3.Use a GitHub Pages site: If your documentation requires more advanced HTML or CSS that Markdown can't support, consider setting up a GitHub Pages site. This will allow you to create full HTML pages that are hosted directly on GitHub, giving you complete control over the rendering of your content without the limitations of a Markdown file. 4.Pre-Render HTML Locally: To reduce the feedback loop, you can pre-render your HTML files locally before pushing them to GitHub. Use a static site generator or an HTML preview tool to see how your content will look before uploading it to your repository. By implementing one or more of these approaches, you can streamline your workflow and ensure that your HTML content renders correctly on GitHub. |
Beta Was this translation helpful? Give feedback.
-
@huseynovelmir, I shall report this comment for spam, too. It is ridiculous that you consider merely reporting LLM-generated text to be useful. Thanks for notifying us, @BugOfBugs. |
Beta Was this translation helpful? Give feedback.
-
|
Beta Was this translation helpful? Give feedback.
-
|
What is LLM? |
Beta Was this translation helpful? Give feedback.
-
@BugOfBugs, I presume that @openssl acting in that way is because your comments are nigh incoherent. I presume you are not a native English speaker? The situation you reference is not equivalent to this one.
A Large Language Model. Google can define it better than I can.
It indeed does, hence the report.
I have had them acted upon for approximately every report I have filed. |
Beta Was this translation helpful? Give feedback.
-
For such words they would call you No. You should presume true my sentence that you quote. Read it again.
Why?
Why mention equivalence? Strictly speaking, they do not spam. Rather cheat. Pretend work. If they themselves distort definition of spam so as to call me. |
Beta Was this translation helpful? Give feedback.
-
|
Must extend request to any file. Can view only HTML - source code. Meanwhile, you may copy HTML into
|
Beta Was this translation helpful? Give feedback.
-
@BugOfBugs, that's because the HTML is being rendered as Markdown. Due to the configuration of the rendering library in use by GitHub, tags with whitespace between them shall be rendered as It is not much of a solution, else the OP would already use a
Can you elaborate? GitHub Pages should support all HTML. Do you mean that configuring it is difficult? If so, I agree. However, enough tutorials exist that most people can ultimately achieve it. Irrespective, it's not a replacement for in-GitHub rendering, much.
That would actually be worth a separate request – send the correct Media Type designation when viewing raw files hosted by GitHub. Want to file it yourself, or have me do so? |
Beta Was this translation helpful? Give feedback.
-
I doubt. No need to use intermediate format.
Not. Because MD is not HTML.
My
How many hours?
No. Add several more codes for pictures, and other files. So HTML may include them. |
Beta Was this translation helpful? Give feedback.
-
@BugOfBugs, that's laughable. You cannot "doubt" what markup parser GitHub utilizes. If you seriously doubt me regardless, read GitHub's documentation. I don't intend to discuss such an absurd topic any more.
That's never been debated. It's irrelevant.
Consequently, it's altered, which contradicts your previous statement.
That absent functionality is not a matter of improvement. Rendering such tags are fundamentally dangerous, and shall consequently never be supported.
If you continue to demean me - this is basic knowledge - I shan't bother to correct you. That's your loss. Irrespective, I do not, for Markdown merely supports rendering inline HTML. That is what you see. Like how YAML is a superset of JSON, CommonMark / Markdown is a superset of HTML (mostly).
It doesn't. Your browser renders the entire page as HTML, because GitHub's servers recompile the source markup to HTML. Solely GitHub needs to know the Media Type.
That would be the purview of a separate request to the WHATWG. However, it's meaningless anyway. |
Beta Was this translation helpful? Give feedback.
-
No. If lacks header of HTTP, rather downloads. If header claims to be HTML, then renders. Try it. I can help.
You fail to mention what is source.
No. Relevant what you store, and see.
Word except removes contradiction.
No. Does pass through much original HTML.
I do not dare.
Thank you, Demeanour.
Other types of files do not need separate requests. |
Beta Was this translation helpful? Give feedback.
-
Select Topic Area
Product Feedback
Body
Hi y'all.
I'm using HTML for most of my docs and content, including READMEs. The problem is: GitHub only supports .md files with inline HTML, which is not friendly to most HTML tools out there. Browsers open .md files as plain text, GitHub itself interprets some lines as Markdown instead of HTML content, and the feedback loop for iterating on documentation is too long:
Would be nice to have plain HTML READMEs so that all the tooling works with them natively.
EDIT: Gitlab -> Github
Beta Was this translation helpful? Give feedback.
All reactions