Comments (12)
from lc-data-intro.
Moving forward, @libcce recommends creating a brief episode on Markdown but not reinventing the wheel i.e focus on why this might be important to librarians.
To summarise above:
- @jt14den recommends https://datacarpentry.org/rr-literate-programming/02-literate-programming/index.html
- @katrinleinweber points to https://commonmark.org/help/
- @weaverbel recommends running Markdown through Pandoc to output various formats, demonstrating its flexibility (see Programming Historian lessons https://programminghistorian.org/en/lessons/getting-started-with-markdown and https://programminghistorian.org/en/lessons/sustainable-authorship-in-plain-text-using-pandoc-and-markdown)
- @libcce points to hackmd.io and using the Carpentries Code of Conduct to learn Markdown (see https://pad.carpentries.org/2018-10-18-Lib-Carp-UNC)
There may be draw drawbacks to Markdown which would need to be considered also i.e. pros/cons.
from lc-data-intro.
@weaverbel this would fit well into https://librarycarpentry.github.io/lc-data-intro/03-foundations/index.html, under 'Use machine readable plain text notation for formatting' and 'Applications for writing and reading plain text files' - these sections touch on Markdown and Pandoc.
I think your approach of an 'instructor demo' is probably the best way to go as pandoc is a command line tool, but both demos would help as stepping stones to the Git/GitHub and Unix Shell lessons. Do you have a set of instructions we could add? Do you think we should add it to the Instructor Notes or as an Exercise in the episode itself for learners to explore?
How long does the demo take?
from lc-data-intro.
@ccronje @weaverbel I pulled together an episode on markdown for teaching with LC http://www.tim-dennis.com/2018-libcarp/04-free-text-markdown/ last year. I used in South Africa and it worked pretty well. I had learners use the hackmd.io service in first two exercises b/c you can create md notes as a guest and download as md, odf or html. The last exercise has them making a blog in github - I got this from @weaverbel when she visited UCLA. The top part of the lesson comes from: https://datacarpentry.org/rr-literate-programming/02-literate-programming/index.html. I'd be happy to submit PRs on parts or help find spots to use if you all think it would be useful.
from lc-data-intro.
from lc-data-intro.
@jt14den the Markdown section (up to YAML) in http://www.tim-dennis.com/2018-libcarp/04-free-text-markdown/ looks good. This plus @weaverbel's pandoc demo would probably take around 15-20 minutes. What do you think about creating a Markdown episode after Foundations?
from lc-data-intro.
@weaverbel Did you try it? If so, is there an action here?
from lc-data-intro.
Maybe we should not talk about it too much, but give learners an interactive tutorial like https://commonmark.org/help/. Do you know other such tools?
from lc-data-intro.
@pitviper6 and I have combined the regex lesson with an intro to Markdown. We've used hackmd.io and had a brief exercise on popular Markdown. We've also used the Carpentries Code of Conduct (which has Markdown and HTML as an example of something to be fixed with regex). We've used regxr.com as helpful tool for interactively working with regex and content like the CoC. Working with the CoC also highlights again the importance of the CoC.
from lc-data-intro.
This is a small section on markdown in https://librarycarpentry.org/lc-data-intro/03-foundations/index.html on the value of machine readable plain text notation. Again, I think this just needs a prod in the right direction for further reading, plus - perhaps - an example of markdown.
from lc-data-intro.
@sharilaster to reframe as a fresh issue for #mozsprint
from lc-data-intro.
Opened #103 as a fresh issue to tag for #mozsprint and #good first issue. Thank you to all contributors for the suggestions!
from lc-data-intro.
Related Issues (20)
- Use of forward slashes HOT 4
- Typo in Keyword END --> AND HOT 1
- Possibly teach parentheses `()` for grouping HOT 1
- `\S` used in solution without being introduced
- improve introductory text to regex HOT 3
- Regular expressions examples in Intro HOT 1
- Make Google Sheets a requirement for the class
- OR (“Finish the expression” in https://librarycarpentry.org/lc-data-intro/02-match-extract-strings/index.html)
- Space or no space in https://librarycarpentry.org/lc-data-intro/04-exercises/index.html
- Use the same term for Lines 55-59 HOT 1
- Lesson Contribution - RegEx Metacharacters
- Need jump lists (anchors) for headings HOT 1
- numbering exercises? HOT 1
- regex.101 quick reference section as 'cheat sheet' in Episode 1 HOT 1
- Hide hints in dropdown to give people a chance to solve the challenge without them
- Scheduling early transition to Workbench HOT 6
- Transition To Workbench in May HOT 15
- Potential revision to initial paragraph (courtesy of @yoyology)
- Links need to be fixed in CONTRIBUTING.md HOT 1
- broken link to Library Hat blog post in 01-regular-expressions.md HOT 2
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 lc-data-intro.