Comments (8)
The idea to "separate" one big file to two smaller halves without intersection means that the overall maintenance burden should be the same.
Certain people mean "CommonMark" when they refer to standardized markdown I think:
https://en.wikipedia.org/wiki/Markdown#Standardization
from dropbear.
Might be fine, but just to widen the view:
Remember GitHub is not the only/main target for this README, but it is included in Dropbear sources downloads from the official website/server: https://matt.ucc.asn.au/dropbear/releases/
When downloading such an archive, Markdown is probably not the format wanted for an universally readable README, especially not a possibly non-standard GitHub-flavoured Markdown format with external resources embedded.
from dropbear.
There is no such thing as "standard" markdown - there exist multiple dialects. Certain subsets of features of them do intersect, however. And if you stick to adding extra whitespace and stay away from advanced features, it should look the same on all output.
I can read downloaded markdown files offline just fine, but if this bothers you, the readme could be separate to a shiny part that appears on the GitHub main page and a more dull (but still markdown) one that contains instructions for installation, usage and whatnot.
from dropbear.
There is no such thing as "standard" markdown
I meant this as of OP sentence:
The current README file is not formatted for GitHub.
GitHub might be not the no. 1 priority, in which case a more generic Markdown syntax way be preferred. E.g. in the open PR
stick to adding extra whitespace
is not done. But otherwise it should be fine.
Generally as a "standard" Markdown, I mean basically this syntax, which should work as intended with every dialect interpreter:
the readme could be separate to a shiny part
Which means two files to maintain.
Don't understand me wrong, I don't want to argue against it and have no vote here anyway. Just want to tell OP why those "necessary changes to formatting" might not be seen as necessary by the maintainer. E.g. the same is true for a "shiny" Dropbear logo, I was wondering about 🙂: #196
from dropbear.
The idea to "separate" one big file to two smaller halves without intersection means that the overall maintenance burden should be the same.
Ah, but since GitHub only shows one readme, whatever you add with the second file, will be missing?
Certain people mean "CommonMark"
Ah right, that is the most complete basic syntax description 👍.
from dropbear.
One can indeed hyperlink other documents from the welcome/landing page on GitHub. The other documents could be in a textual format even.
from dropbear.
But those hyperlinked documents (unless images and such) cannot be expanded, is it? I know there are Markdown extensions which allow loading of external files, but I'm not aware of GitHub dialect supporting this.
from dropbear.
I don't know of a dialect that supported inlining either.
Some support various HTML tags within the Markdown code, but I consider that cheating.
from dropbear.
Related Issues (20)
- There is no command to limit the simultaneous connection of users HOT 2
- Log improvement: name the key
- Bad `authorized_keys` is not reported in non-debug mode HOT 5
- dropbear 22.83 patch error in lede/optnwrt HOT 1
- Minor clarification for DEBUG_TRACE HOT 1
- dbclient can't connect to embedded dropbear server HOT 4
- sshkey file layout HOT 1
- dropbear for android error ` fstatat64(AT_FDCWD, "//.ssh` HOT 1
- Can I Replace LibTomCrypt with OpenSSL? HOT 3
- Ability to configure the `authorized_keys` file HOT 2
- Error if I use scp from same network with python paramiko HOT 2
- cannot login just with private key HOT 2
- Long time to authorize HOT 15
- Make dropbearkey as ssh-keygen HOT 1
- The terminal process cannot be closed correctly HOT 5
- release request (terrapin) HOT 3
- How do you change the port number for SSH server? Where is the dropbear configuration file located? HOT 2
- Dropbear limited scalability HOT 1
- how to set the unlock time for user using dropbear? HOT 2
- -static-pie: Aiee, segfault! You should probably report this as a bug to the developer HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from dropbear.