Giter VIP home page Giter VIP logo

primer-markdown's Introduction

⚠️ This repo is deprecated!

We've moved all of the Primer CSS modules to a single repository. You can still install and update primer-markdown with npm or Yarn, but its code and issues now live elsewhere.

primer-markdown's People

Contributors

broccolini avatar cmwinters avatar jonrohan avatar muan avatar shawnbot avatar simov avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

primer-markdown's Issues

`word-break: break-word` for everyone?

We manually provide this in a few instances on github/github—right now it's specific to #readme .markdown-body. I imagine this is something we should just set on every .markdown-body though since I'm fixing a bug in our wikis to do the same thing.

primer-user-content symlink?

This is mostly a question for @benogle.

What's the purpose of the symlink in the project root? I don't see anything noted in the readme for it. Is there something else this affects that coincides with the package name perhaps for imports?

Ship list

Here's what we'll need to to ship this. Feel free to add to it.

  • Audit/nuke issue and pull comments
  • Change repo/file names to be less Markdown specific
  • Add the package to the Bower registry

We could potentially just copy this into a new repo for the name change, which would take care of the issue audit.

Emoji shouldn't have a background

Emoji get the img element's white background, which makes emoji in the alternating grey rows of tables look a little funny:

Test Test
👍
👍

I'm happy to open a PR for this, but I'm not sure which place to add it in:

Seems like most PRs in this repo are made to the components files, in which case I'd add background: none; here:

https://github.com/cmrberry/markdown/blob/background-free-emoji/components/markdown.scss#L525-L527

But the actual css that affects seems to be in the dist folder:

https://github.com/primer/markdown/blob/master/dist/user-content.css#L204-L206

Does that get auto-updated when changes are made to the components files? Thanks for your patience in dealing with a total newbie question 😁

Not rendering some symbols in Google Chrome (Windows 8)

Some symbols not correctly rendering (⬆ for example).

In Chrome:
image

In Firefox and IE all good:
image

Symbols correctly rendering if styles will be changed:
from

.markdown-body {
  font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif;
}

to

.markdown-body {
  font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif; "Segoe UI Symbol";
}

Questions & Shipping this month

Just to give folks a heads up, I plan on shipping this to genpop later this month (maybe next week?) once everything settles with our recent tweaks. I've made a few more readme edits and might make some more changes. Two quick questions though:

  • We don't use Grunt in our workflows, so I'll probably just remove it. Any objections?
  • Is the components/ folder necessary for anything?
  • Does anyone want to stay on the Primer team? Our other private repos here aren't really used anymore, but we'll keep them around for now. If you'd like to be included, give me a shout.

Lastly. I very much view this as a test ground for future open sourcing of more Primer components. Minimal tooling and basic documentation, but with the help of the community for bug reports, iterations, etc seems like a good balance for us.

/cc @benogle @bkeepers @cameronmcefee who have all had shared code, feedback, and such.

Usage example

I cannot find any example of usage. Would help to get started with quickly.

publish to npm?

Hey guys,

I have a tiny docs project that uses npm for package managment and build scripts...I'd love to pull this in, but would prefer to use npm to do so.

I noticed an unfinished discussion (#4) regarding an npm package...can I haz this on npm?

Is CSS for language syntax highlighting inside Fenced Code Blocks available?

Hi,

If I understand correctly, this repository looks like the CSS to support (GitHub Flavored) Markdown, and includes the CSS for things like headers, lists, tables, images, links, spacing and so on. That's great!

Does it also include CSS for syntax highlighting of languages inside Fenced Code Blocks? For example, if I render the following Markdown document using the raw Markdown rendering API endpoint:

Hello **world**.

```diff
+added
-removed
```

```Go
err := http.ListenAndServe(":8080", mux)
```

Which can be done using the following curl command:

$ curl -X POST -H 'Content-Type: text/x-markdown' https://api.github.com/markdown/raw -d $'Hello **world**.

```diff
+added
-removed
```

```Go
err := http.ListenAndServe(":8080", mux)
```
'

The response is:

<p>Hello <strong>world</strong>.</p>

<div class="highlight highlight-source-diff"><pre><span class="pl-mi1">+added</span>
<span class="pl-md">-removed</span></pre></div>

<div class="highlight highlight-source-go"><pre><span class="pl-smi">err</span> <span class="pl-k">:=</span> http.<span class="pl-c1">ListenAndServe</span>(<span class="pl-s"><span class="pl-pds">"</span>:8080<span class="pl-pds">"</span></span>, mux)</pre></div>

Does this repository contain the neccessary CSS to style those classes such as pl-mi1, pl-md, pl-c1, pl-s, etc., to be able to render that Markdown to look like the following:


Hello world.

+added
-removed
err := http.ListenAndServe(":8080", mux)

If not, is it available somewhere else? Is it going to be available in the future?

Thank you!

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.