[libc-commits] [PATCH] D137090: [libc] Add example programs and their CMake build and instructions.

[Jeff Bailey via Phabricator via libc-commits]

jeffbailey accepted this revision.
jeffbailey added a comment.

I'm marking this as accepted - only the language annotation on the code blocks remains, but I think you'll have to just try something and see how the github MD interpreter copes with it.  Thanks!



================
Comment at: libc/examples/README.md:15
+
+```
+$> cd <example> # example $> cd hello_world
----------------
sivachandra wrote:
> jeffbailey wrote:
> > +.. code-block:: sh  ?  (Here and below)
> I think the the `.. code-block::` syntax is for `.rst` files? This is a `.md` file to be rendered like the README.md file here: https://github.com/llvm/llvm-project/tree/main/libc/src/__support/CPP. The idea is that this is a less formal document as opposed to the docs in the `docs` directory which are of a formal nature. I am calling it "less formal" to imply that this will have much more churn than the docs in the `docs` directory.
Ah!  I hadn't realized that this isn't an rst file.

So, looking at: https://github.github.com/gfm/#info-string and https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code it looks like it's possible to do:

,,,bash  (where those are backticks rather than commas, but this box is interpreting the MD if I use actual backticks)

However, I have no idea how to test this before committing it =)

I'm also not sure if you have to remove the "$> " as well.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D137090/new/

https://reviews.llvm.org/D137090