Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a contributing guide #18

Open
Fcmam5 opened this issue Nov 26, 2016 · 4 comments
Open

Add a contributing guide #18

Fcmam5 opened this issue Nov 26, 2016 · 4 comments

Comments

@Fcmam5
Copy link

Fcmam5 commented Nov 26, 2016

As newbie, I'd like to help but I'm little bit lost I don't know where I can add/edit properties.

@roryokane
Copy link

roryokane commented Nov 28, 2016

Here’s some text the Contributing guide could include:

The [`property/`](https://github.com/jgthms/css-reference/tree/master/property) directory contains the HTML descriptions of each property. For example, the explanation and examples for the [`align-content`](http://cssreference.io/property/align-content/) property is in [`property/align-content/index.html`](https://github.com/jgthms/css-reference/blob/master/property/align-content/index.html).

The property/ directory contains the HTML descriptions of each property. For example, the explanation and examples for the align-content property is in property/align-content/index.html.

However, I am confused by seeing that the text in those HTML was apparently generated from Markdown, yet I don’t see any Markdown source files in the repo. It would be nice if the contributing guide either pointed to the Markdown files or explicitly said “while Markdown was used for the initial build, changes from now on should be made in the raw HTML”.

@yuezk
Copy link

yuezk commented Nov 30, 2016

@roryokane I think it was written in HTML, not markdown. But it missed some build scripts. For example, how to generate files in _includes/collections or _includes/lists?

@roryokane
Copy link

@yuezk Here is why I think the text was originally written with Markdown:

  • _config.yml contains markdown: kramdown
  • a typo involving ** double-asterisks caused some text to be bolded incorrectly

@yuezk
Copy link

yuezk commented Dec 1, 2016

@roryokane,you are right. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants