GithubHelp home page GithubHelp logo

minad / creole Goto Github PK

View Code? Open in Web Editor NEW

This project forked from larsch/creole

10.0 10.0 7.0 57 KB

Creole 1.0 to XHTML converter written in ruby

Home Page: http://rdoc.info/projects/minad/creole

License: Other

Ruby 100.00%

creole's People

Contributors

ktdreyer avatar larsch avatar lcpriest avatar minad avatar phaedryx avatar rzhade3 avatar tbuehlmann avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

creole's Issues

Ambiguous license

The license information for Creole is a little confusing. The "LICENSE" section of the README says:

Creole is Copyright (c) 2008 - 2013 Lars Christensen, Daniel Mendler. It is free software, and may be redistributed under the terms specified in the README file of the Ruby distribution.

I think this is meant to refer to the README file of the Ruby programming language, but there is no license in the Ruby README -- it points to the Ruby COPYING file. The Creole LICENSE file contains a near-identical copy of the Ruby license, but it's missing the corresponding BSDL file that is referenced to in the LICENSE file.

I suggest adding the BSDL license file to the repo and changing the license statement in the README to point to the LICENSE file.

Thanks for your consideration!

Escape character doesn't work correctly.

If I put '~' before freestanding link(example: ~http://google.com/), I should get output string without link, but I get it with link.
More examples of unobvious working of escape character:

  1. I write ~// something //, I get // something.
  2. I write
    * f
    ~* d
    I get
  • j * d
  1. I write
    {{{
    ~}}}
    }}}
    I get ~}}}, but I should get }}}.

P.S. I'm talking about creole parsing in Github, and I haven't compile this project yet.

Please make the license more clear

I'm running license auditing tools and am getting warnings about creole having no license, which would technically mean it's copyrighted and no one may use it. Clearly many projects (including sinatra) are using creole, and that's obviously your intent.

  • There is no license file.
  • The readme says this is "free software" but otherwise just recursively refers to itself.
  • The gemspec declares s.license = 'Ruby'.
  • There is no license named ruby. However, the ruby language is distributed under a BSD-2-Clause license.

Please create a LICENSE file with the BSD-2-Clause content linked above, and remove or update the license section of the readme.

Ruby 3 in CI?

@minad what do you think about explicitly adding Ruby 3 into the Ci matrix? I know ruby-head is in there - not sure when the last pipeline was run, so I don't know if Ruby 3 was ever tested.

I tried it myself locally. Tests passed on both 3.0 and 3.1

I'm happy to put together a PR if you would consider it.

I'm curious as to whether travis is still working, or would we have to convert to GitHub actions.

There is no way to create inside-page anchors other than using HTML

It would be nice if Creole automatically generates id or name attributes for headings, and/or provides a markup syntax to explicitly set id or name for heading or other elements. Currently it's not possible to have a link point to a location inside a page with url#id, except creating an anchor using raw HTML like {{{<h1 id="MyHeader">My Header</h1>}}}.

wikicreole.org link

wikicreole.org link is poorly formatted and doesn't link to an actual page

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.