GithubHelp home page GithubHelp logo

API for RakuDoc v2 about problem-solving HOT 2 OPEN

finanalyst avatar finanalyst commented on August 11, 2024
API for RakuDoc v2

from problem-solving.

Comments (2)

finanalyst avatar finanalyst commented on August 11, 2024

My proposal would be for:

  • directives (there is a list of names) to be placed in a RakuAST::Doc::Directive node
    • the name field/attribute would be the directive name
    • meta would contain any metadata option associated with the directive
    • object would contain the first argument
    • predicate would contain the second one
  • markup codes (no change from current RakuAST::Doc::Markup)
  • blocks to be placed in a RakuAST::Doc::Block node
    • 'name' contains the block name
    • 'type' contains 'built-in', 'custom', 'semantic'
    • 'meta' to contain meta options
    • 'contents' to contain the block contents

Currently, RakuAST provides a RakuAST::Doc::DeclaratorTarget node for the declarator blocks, which is consistent with the code/text distinction.

If this code/text distinction is carried through to the API, then there should be separate nodes for the =finished directive and =data block.

from problem-solving.

lizmat avatar lizmat commented on August 11, 2024

Closing, since the discussion is in now in https://github.com/Raku/RakuDoc-GAMMA . Please re-open if you disagree.

from problem-solving.

Related Issues (20)

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.