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

Markdown pages #120

Closed
wants to merge 2 commits into from
Closed

Markdown pages #120

wants to merge 2 commits into from

Conversation

peterdesmet
Copy link
Member

In a follow up of #118, I have created a Markdown version of the standards page.

Remarks:

  • Translation of: https://github.com/okfn/data.okfn.org/blob/master/views/standards/index.html
  • The page contains 6 relational links: depending on where the page lives, they might need to be updated.
  • I kept the div for the side menu .well, but depending on how the html page is generated (what engine is used for this?) this might need some updating
  • I placed this file in the /doc directory. Probably a new directory should be created for all Markdown content of the site.
  • This branch can be used to create markdown versions of all pages of the website (e.g. before being merged), but I'll needs some input on how best to move forward.

Based on:
https://github.com/okfn/data.okfn.org/blob/master/views/standards/index.
html

Notes:

* The two links in the file might not work
* The first image is no longer small and float:right
@rufuspollock
Copy link
Contributor

@peterdesmet have you tested this locally - ie. run node run.js and looked at the site?

@peterdesmet
Copy link
Member Author

I haven't. I guess I should follow the instructions in the README to get this running locally?

@rufuspollock
Copy link
Contributor

@peterdesmet yes - don't worry if this is too much hassle but it would be super useful :-)

@peterdesmet
Copy link
Member Author

Well, that wasn't too hard to do. Here's the result:

local-page

As mentioned above, there are a couple of issues:

  • We would need a single directory (e.g. pages) for all markdown pages that make up the website. standards.md could be placed in the root of that directory, while the documentation can stay together in pages/doc. The config to create the site would have to be updated.

  • When can then also use another html template for standards. Currently the doc template is used, which is narrower and has no side menu.

  • If we want to keep the side menu, we would have to find a solution to include this. It's fairly easy to hardcode this in the standards template, but it would be much better if that content was also in the markdown page. My current attempt (wrapping my markdown in <div class="well">) however doesn't parse the markdown:

    screen shot 2014-08-13 at 16 08 47

@rufuspollock
Copy link
Contributor

Good work but I wonder if we just leave this as a template for the moment as it seems painful to get perfectly right - unlike the docs we won't edit it so much.

BTW: would really love your assistance improving http://data.okfn.org/doc/publish-geodata

@peterdesmet
Copy link
Member Author

Improving geospatial data documentation: do you mean continuing this discussion?

@rufuspollock
Copy link
Contributor

Yes - just left a comment there.

@rufuspollock
Copy link
Contributor

OK, i'm closing this PR for the time being.

@rufuspollock rufuspollock deleted the markdown-pages branch April 30, 2016 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants