hastexo / olx-utils

Tools facilitating the creation of Open edX courseware in the Open Learning XML (OLX) format
GNU Affero General Public License v3.0
5 stars 5 forks source link

Example .md file? #21

Open natea opened 6 years ago

natea commented 6 years ago

Is there an example .md file that you can provide to see how it translates this file into OLX? I'd like to see how far this .md file differs from the .md files that we need to import into Open edX.

fghaas commented 6 years ago

Here's an example:

<%namespace file="/olx_partials.xml" import="asset_url"/>\
Congratulations!
================

<!-- Note -->
This concludes the OpenStack Deployment and Operations course.

Over these 32 lessons, you have acquainted yourself, in detail, with
the basics of OpenStack and cloud computing.

However, there is much more for you to discover as you dive deeper
into the OpenStack platform and community.

Where to go from here
---------------------

<!-- Note -->
OpenStack comes with an excellent set of high-quality documentation at
<https://docs.openstack.org/>.

This includes some well written and insightful guides like:

  * [Administrator Guide](https://docs.openstack.org/admin-guide/)
  * [High Availability Guide](https://docs.openstack.org/ha-guide/)
  * [Operations Guide](https://docs.openstack.org/ops-guide/)
  * [Security Guide](https://docs.openstack.org/security-guide/)
  * [Architecture Design Guide](https://docs.openstack.org/arch-design/)
  * [Networking Guide](https://docs.openstack.org/ocata/networking-guide/)
  * [Virtual Machine Image Guide](https://docs.openstack.org/image-guide/)

There is reference documentation available on OpenStack Python
bindings and OpenStack API for application developers at
<https://docs.openstack.org/developer/language-bindings.html>

There is also an official
[YouTube channel for OpenStack](https://www.youtube.com/user/OpenStackFoundation),
containing tutorials and conference talks.
natea commented 6 years ago

Thanks! Do you have any example Markdown files with code samples? In particular, I'm trying to demonstrate that olx-utils can translate Markdown that has code samples, and render it with syntax highlighting.

On Fri, Mar 9, 2018 at 3:49 PM, Florian Haas notifications@github.com wrote:

Here's an example:

<%namespace file="/olx_partials.xml" import="asset_url"/>\ Congratulations!

This concludes the OpenStack Deployment and Operations course.

Over these 32 lessons, you have acquainted yourself, in detail, with the basics of OpenStack and cloud computing.

However, there is much more for you to discover as you dive deeper into the OpenStack platform and community.

Where to go from here---------------------

OpenStack comes with an excellent set of high-quality documentation at https://docs.openstack.org/.

This includes some well written and insightful guides like:

There is reference documentation available on OpenStack Python bindings and OpenStack API for application developers at https://docs.openstack.org/developer/language-bindings.html

There is also an official YouTube channel for OpenStack, containing tutorials and conference talks.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/hastexo/olx-utils/issues/21#issuecomment-371941035, or mute the thread https://github.com/notifications/unsubscribe-auth/AAHQyBmgFkvYoNogTl3tyt-rUW4xe-Qjks5tcurAgaJpZM4SfRqL .

--

Website: http://www.appsembler.com Blog: http://www.appsembler.com/blog Twitter: http://twitter.com/natea LinkedIn: http://linkedin.com/in/natea Phone: +1 (617) 702-4331

fghaas commented 6 years ago

It's pretty simple, really, just use 3 backticks. Here's an example for YAML:

```yaml
  myconfig:
    type: "OS::Heat::CloudConfig"
    properties:
      cloud_config:
        package_update: true
        packages:
        - emacs-nox
        - cowsay
```
natea commented 6 years ago

Thanks! I see that for javascript it's just 3 backticks and js

When I run the olx-utils in the git repo, I don't see any new files being generated. I've put a file static/markdown/example.md, and I would expect there to be some kind of output.

I'm guessing that this line has something to do with it, but it's not clear from the documentation how this is actually referenced, and where it loads the partial:

<%namespace file="/olx_partials.xml" import="asset_url"/>\

Do you have an example course where you've utilized the olx-utils script that might shed some light on the actual usage of the script?

natea commented 6 years ago

If you don't feel comfortable sharing an entire tarball of a course, maybe you could just share some Markdown file examples that show how the partials are used to generate the OLX file for importing into Open edX?