Git Product home page Git Product logo

Comments (4)

tavip avatar tavip commented on September 28, 2024

Ah, didn't noticed that. The other option would be to replace the existing Linux kernel README with a link to Documentation/lkl.txt but initially I felt like I should not touch that.

Any other options? Can we tell GitHUB to use another file instead of README?

from linux.

cemeyer avatar cemeyer commented on September 28, 2024

I believe we could just indent code blocks in lkl.txt by 4 spaces, and that should render OK. And it may still be acceptable for Documentation/*.txt.

Standard Markdown converts text with four spaces at the beginning of each line into a code block; GFM also supports fenced blocks. Just wrap your code in ``` (as shown below) and you won't need to indent it by four spaces. … Keep in mind that, within lists, you must indent non-fenced code blocks eight spaces to render them properly.

https://help.github.com/articles/github-flavored-markdown/

I don't know if Github would let us specify another file (I didn't know it would chase README.md symlinks, either).

from linux.

tavip avatar tavip commented on September 28, 2024

Yes, indent sounds nice. Fixed in commit 3024076.

from linux.

cemeyer avatar cemeyer commented on September 28, 2024

Looks good.

from linux.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.