Coder Social home page Coder Social logo

zag / js-pod6 Goto Github PK

View Code? Open in Web Editor NEW
9.0 2.0 0.0 2.25 MB

Pod6 is an easy-to-use markup language. It can be used for writing language documentation, for documenting programs and modules, as well as for other types of document composition

Home Page: https://pod6.in

License: MIT License

JavaScript 1.83% Raku 32.74% Perl 1.44% TypeScript 58.98% PEG.js 5.01%
pod6 markup-language rakudoc podlite rakupod raku-pod rakulang

js-pod6's People

Contributors

dependabot[bot] avatar zag avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

js-pod6's Issues

Polish https://pod6.in/

I think an online Pod6 editor is a brilliant idea and has the potential to promote Pod6 a lot because of its approachability. (Opening a website has the lowest barrier of entry one can possibly have.) So this issue is mostly an encouragement to polish the https://pod6.in/ website more.

Here are just some ideas of what could be done:

  • Give it a logo and a shiny page header
  • Add an "About" button
  • Link to the repo with a GitHub icon
  • Add a link to https://docs.raku.org/language/pod
  • Add a basic syntax documentation on the page itself
  • Do some SEO so it pops up at the top when googling "pod6 editor" and "pod6 editor online"
  • Add more expressive HTML highlighting (in the right column). Compare the a docs page with viewing the pod in pod6.in
  • Add some POD highlighting (in the left column).
  • Persist edited content (in a cookie?), so it's not lost on reload.

Rendering of rakudoc tables

Thank you for creating https://pod6.in/ to render pod6 to html. That was very much needed tool.

I was trying to render this content

=head3 Rendering of rakudoc tables to html

=table
    Animal | Legs |    Eats
    =======================
    Zebra  +   4  + Cookies
    Human  +   2  +   Pizza
    Shark  +   0  +    Fish

=table
    X | O |
   ---+---+---
      | X | O
   ---+---+---
      |   | X

=table
    X   O
   ===========
        X   O
   ===========
            X

In the first table, the row content were all in single row. In the second and third tables, the column alignment was not clear.

Capture1

I also tested the same with Pod::To::HTML which renders fine.
Capture

I think this could be improved in future releases.

Fail process anchors in L<>

Fail process anchors in L<>
Example:
L<https://www.python.org/dev/peps/pep-0001/#what-is-a-pep>
not render as links.

TypeError: [].concat(...).flat is not a function

Summary

I tried pod6.in. It didn't work. Details follow.

My system details

I'm using:
Firefox
Version 61.0.1
Build ID 20180712135629
User Agent Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:61.0) Gecko/20100101 Firefox/61.0
OS Linux 4.15.0-29-generic
Multiprocess Windows 1/1 (Enabled by default)
Web Content Processes 4/4
Enterprise Policies Inactive
Google Key Found
Mozilla Location Service Key Missing
Safe Mode false

What happened

When I arrived at pod6.in I saw a page with a title at the top (pod6 to html (0.0.17) and two panes.

On the left was pod:
=head1 Title
=head2 Subtitle
etc

On the right was:

There may have been an error. Check pod6 syntax at Synopsis 26 or please, fill issue here.

Technical details (please, attach this to issue):

TypeError: [].concat(...).flat is not a function

A<>: wrap spaces around identifier

Parse content of A<identifier> with no spaces around identifier only.
Can't parse:

A<   identifier>
A<identifier   >
A<   identifier  >

It is ok for:
A<identifier>

TODO: alias placements: A<> and =alias

For example:

=begin code
    =alias PROGNAME    Earl Irradiatem Eventually
    =alias VENDOR      4D Kingdoms
    =alias TERMS_URL   L<http://www.4dk.com/eie>
    The use of A<PROGNAME> is subject to the terms and conditions
    laid out by A<VENDOR>, as specified at A<TERMS_URL>.
=end code

:numbered does not work

This option specifies that the block is to be numbered
For example:

=for head2 :numbered
Subtitle

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.