{"id":16222916,"url":"https://github.com/michael/ndogen-client","last_synced_at":"2025-04-08T01:41:36.137Z","repository":{"id":957985,"uuid":"743568","full_name":"michael/ndogen-client","owner":"michael","description":"On-the-fly documentation generation powered by ndogen","archived":false,"fork":false,"pushed_at":"2010-08-27T20:59:25.000Z","size":465,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-14T01:45:58.435Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/michael.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2010-06-27T18:05:37.000Z","updated_at":"2019-08-13T14:34:36.000Z","dependencies_parsed_at":"2022-08-16T11:35:23.423Z","dependency_job_id":null,"html_url":"https://github.com/michael/ndogen-client","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michael%2Fndogen-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michael%2Fndogen-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michael%2Fndogen-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michael%2Fndogen-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michael","download_url":"https://codeload.github.com/michael/ndogen-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247761052,"owners_count":20991533,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T12:15:49.487Z","updated_at":"2025-04-08T01:41:36.119Z","avatar_url":"https://github.com/michael.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"ndogen-client\n===================\n\nA viewer for a all-new ambitious [source documentation format](http://github.com/oliver----/ndogen). ;-)\n\nNdogen exposes documentation as data (JSON) instead of pre-rendered HTML. \nThis approach not only saves some bytes at transmission, it also allows clients to individually render the result.\n\nI'll start with a clean document output format, with some unobtrusive interaction (navigation, search, etc.).\n\n\n\nndogen Syntax (Early Draft)\n-------------------\n\n    NDOGEN - Natural text markup\n    =================================================================\n\n    Ndogen exposes documentation as data (JSON) instead of pre-rendered HTML. \n    This approach not only saves some bytes at transmission, it also allows\n    clients to individually render the result. \n\n\n    Block Elements\n    -----------------------------------------------------------------\n\n    Paragraph\n    .................................................................\n\n    A paragraph is simply one or more consecutive lines of text, separated\n    by one or more blank lines. Normal paragraphs should not be indented with\n    spaces or tabs.\n\n\n    Sections\n    .................................................................\n\n    Sections, inspired by the Setext-style, are “underlined” using equal signs\n    (for first-level sections) and dashes (for second-level sections) or dots \n    (third-level sections).\n\n    For example:\n\n    $ Section 1\n    $ =============\n    $ \n    $ Section 2\n    $ -------------\n    $ \n    $ Section 3\n    $ .............\n\n\n    Unordered Lists\n    .................................................................\n\n    Ndogen supports nested lists and hanging indents.\n\n    $  * Red\n    $  * Green\n    $    Additional Line\n    $    * Dark Green\n    $    * Light Green\n    $  * Blue\n\n\n    Ordered Lists\n    .................................................................\n\n    $  # Red\n    $  # Green\n    $    Additional Line\n    $    # Dark Green\n    $    # Light Green\n    $  # Blue\n\n\n    Code Blocks\n    .................................................................\n\n    Use preceded $-signs to denote code blocks.\n\n    $ $ $(function() {\n    $ $   ndogen.run();\n    $ $ });\n\n\n    Topics\n    .................................................................\n\n    $  A Topic:\n    $  \n    $  A subsequent paragraph,\n    $  with some text\n\n\n    Definitions\n    .................................................................\n\n    $  First definition:    The value can be a paragraph\n    $                       or any other element.\n    $\n    $  Second definition:   * Item 1\n    $                       * Item 2\n\n\n    Span Elements\n    -----------------------------------------------------------------\n\n\n    Links\n    .................................................................\n\n    Links are ready to be used inline. Links can be references to local\n    anchors or external resources.\n\n    $ An external Link[http://quasipartikel.at].\n    $ For more than one word as the link name you have to use quotes. \n    $ \"See here\"[http://github.com/oliver----/ndogen]\n    $ \n    $ This is a references to a local anchor [SomeAnchor]\n\n\n    Emphasized text\n    .................................................................\n\n    $ _Single underscores_ or *single asterisks*\n\n\n    Strong text\n    .................................................................\n\n    $ _Double underscores_ or *double asterisks*\n\n\n    Inline Code\n    .................................................................\n\n    $ You can create an instance with `new Person()`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichael%2Fndogen-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichael%2Fndogen-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichael%2Fndogen-client/lists"}