GitHub Flavored Markdown in Atom
License: MIT License
Adds syntax highlighting and snippets to GitHub flavored Markdown files in Atom.
Contributions are greatly appreciated. Please fork this repository and open a pull request to add snippets, make grammar tweaks, etc.
Hopefully the screenshot says it all. For searching purposes if nothing else here's a plain text attempt to explain the problem:
Syntax highlighting in the markdown file itself (in the editor, not the preview) does not seem to work when a header is specified by underlining it with '=' or '-'. It works fine for headers starting with '#' or '##'.
It's reproducible every time with this file in Atom 0.90.0
No classes are applied to links and italics within block quotes:
I'd imagine other markup is not found, too.
Text below horizontal rule. The issue is that the triple backtick ending the code block
seems to be treated as a docstring. All text after it is green when it should be grey.
Consider this code:
def item_in_list(to_check, the_list):
for item in the_list:
if to_check == item:
return True
return FalseSo if we call this function like item_in_list(2, [1,2,3]), it should be pretty
quick.
The syntax highlighting fails when the wrapping operators are on separate lines. Tested for both bold and italics.
_this wont be
syntax highlighted_If one wants to write a * as a normal char, not as a bold or italic start char, things will go wrong.
Even,when there is no newline after the line contains the *
When the * is the last char of one line, everything is ok...
Shouldn't fences be able to understand any arbitrary grammar highlighting available to atom? At the bare minimum, they should understand those understood by GFM.
https://github.com/github/linguist/blob/master/lib/linguist/languages.yml
As far as implementation goes, I'm sure there must be some option other than building a ton of regexes for gfm.cson using this YML file. That's probably really inefficient? Is there some way to use a callback with a capture group in the regex?
edit: Solving this issue would solve #33, and any future requests for syntax support. If someone more familiar with atom could describe a better method than parsing that YML, I'd write the PR.
Given Markdown such as the following:
The following code shows complete example how to use styleguide with gulp-sass and with gulp watch.
var styleguide = require('sc5-styleguide');
var sass = require('gulp-sass'),
var outputPath = 'output';
gulp.task('styleguide:generate', function() {
return gulp.src('*.scss')
.pipe(styleguide.generate({
title: 'My Styleguide',
server: true,
rootPath: outputPath,
overviewPath: 'README.md',
styleVariables: 'lib/app/sass/_styleguide_variables.scss'
}))
.pipe(gulp.dest(outputPath));
});The asterisk in *.scss gets parsed as a Markdown emphasis character, causing the rest of the code block to appear in italics. It looks like the grammar doesn't recognize indented code blocks at all (instead only recognizing fenced code blocks).
This bug isn't visible in the Atom Dark or Atom Light themes, but is visible in the Base 16 Tomorrow themes.
Hoping erlang syntax highlighting support。
Thank you.
From @bric3 on February 21, 2015 14:39
I was writing a simple git documentation for some colleagues, with bash hightlighted snippet, but Atom miss-highlight if there's the until word and only with the bash style.
```bash
git log --since="1 week ago" --until="yesterday"
```Changing the word a little (adding/removing a letter) highlighting is correct.
See :
Incorrect :
Correct (but changing one letter of the until letter):
OS : OSX 10.10.2 Yosemite
Atom : 0.182.0
Copied from original issue: atom/atom#5664
It would be nice to have markdown headings fold like the unordered and ordered lists currently do.
For comparison, TextMate folds the area between any heading and the next heading, regardless of level. Instead, I think it would be nicer if headings folded the region from any heading to just above the next heading of equal or higher level. That seems more logical, it follows the logic of dedicated GUI outliners, and it's friendlier to the obsessively organized.
I spent a few minutes looking though the package to see how it's done (in the hope of making a full request), but I never found it. I have basically zero experience with bundles, so that's not surprising, though I did find folding in TextMate's markdown bundle.
Atom interprets an with an backslash escaped underline character as start of an italic sequence. The same behaviour is happening with *s.
Like in the Markdown definition is written:
Markdown allows you to use backslash escapes to generate literal
characters which would otherwise have special meaning in Markdown’s
formatting syntax.
Stuff like —.
If it's possible, I'd like to be able to specify a different font when working with markdown files (for example a serif font).
Is this in the scope of language-gfm or would that be a more general part of atom (for all packages' settings)?
Currently, the ⌘-/ keybinding comments the line/selection using C-style:
/*My paragraph.*/
It should use HTML-style:
<!-- My paragraph. -->
Windows 7.
Using code example from GitHub:
I have an image link like this:
[{.image-right .image-25}](http://www.apple.com/aperture/)
Language-GFM chops it into weird pieces:
The first opening [ gets assigned nothing.
![Aperture Icon gets assigned .entity .gfm.
The first closing ] gets assigned nothing.
The final closing ] gets assigned nothing.
I'm not sure if the [] pairs are supposed to get a class, or not. In other situations, they do not, so perhaps that's how it's expected to be.
But in this case, at least the ![ may not be supposed to get a class.
Now that there is a CommonMark spec, suite of tests and community. The language-gfm package should support it.
For writing Markdown, it would be fairly handy to have characters (like backticks, astrisks and underscores) match.
It seems like the bracket-matcher package pretty much has this covered. With a one line diff I was able to make backticks match:
diff --git a/lib/bracket-matcher.coffee b/lib/bracket-matcher.coffee
index 60245f5..92d9d02 100644
--- a/lib/bracket-matcher.coffee
+++ b/lib/bracket-matcher.coffee
@@ -8,6 +8,7 @@ module.exports =
'{': '}'
'"': '"'
"'": "'"
+ "`": "`"
activate: ->
atom.workspaceView.eachEditorView (editorView) =>But modifying that package doesn't seem like the right thing to do, because:
I'm happy to explore it but just looking for a bit of guidance:
bracket-matcher?bracket-matcher within GFM?Copy markdown from one document and paste into another loses all indentation. Both docs are have their type set to Github Markdown.
Windows 0.153.0
From @50Wliu on March 18, 2015 12:11
From @diagramatics on March 18, 2015 10:37
I'm talking about [**this**](). Markdown Preview seems to make it a valid formatting but the editor doesn't make it bold, only color highlights.
To prove it, this is a valid formatting in GitHub.
Copied from original issue: atom/atom#6017
Copied from original issue: atom/markdown-preview#218
line 176, the code style is interrupted by the asterisk.
Many markdown files have YAML as front matter before the start of the markdown.
Would it be possible for language-gfm to recognize that and style it as does language-yaml?
Should Markdown Extra be including in this language's support?
Issue #47 suggests adding CommonMark support which may end up including this request.
Text such as _template: page confuses language-gfm into thinking all the rest of the text in the document is italicized.
If an asterisk is used inside of the syntax highlighter for C++ highlighting, it appears it italicizes the rest of the document.
Reduced sample markdown (this appears to work fine on GitHub. It is broken in Atom)
```cpp
struct Italics
{
Italics *node;
};
```
hello
GFM, the language, supports _bold italic_ but the syntax highlighting of GFM does not. The following Markdown:
***bold italic***Is marked up simply as ["source.gfm"] rather than ["source.gfm", "markup.bold.gfm", "markup.italic.gfm"] as I would expect. Another example to try:
*You **can** combine them*Taken from the Emphasis section of Mastering Markdown.
... but colors correctly after the fenced code block is closed.
long count_bits(long number) {
// blah blah blah blahdy blah blah
}The syntax coloring breaks at the parameter list.
The preview markdown feature and the overall markdown support in Atom is nice so far, but it has some tab-finding/indention problems when entering code inside code block declarations.
It annoyingly unindents code you've already typed if you use a line return, and it seems to not have any syntax highlighting for yaml codeblocks within your markdown file.
Can we have CriticMarkup support in gfm?
In the most simple form this would insert an empty list item when you hit return.
* List item
* Another item| <--- returnWould insert a new item:
* List item
* Another item
* |Hitting return again would clear that item.
* List item
* Another item
|Doing so mid list would also insert a new item, I.e.:
* List item
* |
* Another itemThis should work with -, + and - [ ] as well as *. It probably gets more tricky with ordered lists because you'd want to increment the number.
1. List item
2. Another item
3. |That's probably hard but not as hard as inserting a new list item mid-list and re-numbering all of the items so you don't end up with:
1. First
2. |
2. Second
3. ThirdI use a package in Sublime that does something similar, but it isn't great. Byword probably has the best implementation which I've put in gif form:
I've tried to hack something in with snippets with no success. I thought a solution might be some kind of context aware keymap. But I'm lost as to where to start.
Atom Version 0.100.0
Mac OS X 10.9.3
language-gfm does not recognize # or ##, etc as headings and applies no classes beyond .source and .gfm.
The line is pretty blurry between text and source, but I feel that since HTML and XML are "text.html" and "text.xml", respectively, that Markdown should also be considered text rather than source.
In the future (hopefully near future) I expect Atom to behave subtly differently depending on whether you're editing text or source ... perhaps like spell-checking text by default or soft wrapping text by default. So I believe this distinction will only become more important to get right over time.
For example, try writing <a target="_blank">Hello</a> in a markdown file in the atom editor and notice how everything after the _ is italicized.
I am writing a document that contains a lot of TeX in Markdown using Atom. The issue is with underscores that appear in the equations. Here is the problem I am having...
\\[ x_1 = 0.86w^{0.75}_c \\]
I have a few paragraphs here.
\\[ x_2 = 0.92w^{0.79}_b \\]
The text between the underscore in the first equation (_c) and the second (_b) is being italicized. These underscores are part of a whole word, so they should not be italic markers.
Are the [] and () pairs in entities such as [Aperture] or in links such as (http://www.apple.com/aperture/) expected to get a class? They don't currently.
I would like it if they got .markup .punctuation classes or perhaps the same class as the text inside them.
I know this is supposed to be github flavored markdown. However a number of people are using language-gfm to write their markdown files to be compiled and rendered to pdf via pandoc.
Is it in the scope of this language package to add highlighting of inline LaTeX code in eg. the math-dollars? I am asking because I get the occasional request wether my syntax theme could highlight pandoc features, which I unfortunately have to dismiss because it's not the task of a syntax theme.
If it is not in the scope of this package, I will try to implement some of those features in a separate package if I get the time… Or wait until somebody does so.
thanks for listening! :)
Currently they aren't highlighted as comments
I noticed this weird highlighting of an ISO date string when writing a Markdown file:
(text is
version of 2014-03-14 19:18:38
)
The scopes inside the '18' are:
["source.gfm", "string.emoji.gfm", "string.emoji.end.gfm"]
(Originally reported in atom/atom#3145 by @5an1ty)
As an example use this code as markdown:
This is a test
_.bindAll(this,'test');
this is the end of the test
This will render two lines as pink because the parser does not notice the _ is in a code block
Whenever I save a .md file, it saves and then the entire contents of the file is selected. That doesn't happen with other file types.
Do I have something misconfigured, or is this something intended?
Could be related to #39
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QB8GQPZAH84N6 "Donate once-off to this project using Paypal")Will break highlighting for everything after it:
https://www.dropbox.com/s/zozxl6cqixtdtsg/Screenshot%202014-08-14%2016.54.27.png
Environment:
See: #7
Test cases:
Working:
***bold italic***
Not Working:
*italic **bold italic** italic*
**bold *bold italic* bold**
I'd like to be able to style a few bits of tables independently:
|, -)
: character should be called out specifically too (as .modifier?)See the Discuss topic that led to this here: http://discuss.atom.io/t/make-reflow-selection-markdown-aware/10995
When reflowing text by including hard returns, syntax highlighting breaks if a hard return is inserted inside the label of a hyperlink at a breaking space. But when the Markdown is ultimately converted to HTML, there is no such issue. For example:
Fullstop works:
I would like to mention @Bengt.
Colon works:
@Bengt, I would like to mention you.
Semicolon fails:
There is @Bengt; I would like to mention him.
Here's what that looks like:
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 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.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
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.