📖 Contenerised documentation generator from in-code comments for CLIPS (inspired by JavaDoc)

Last update: Apr 18, 2022

Related tags

Overview

clips-doc

Installation

Download the clips-doc.docker.tar Docker image. You will need docker to proceed.

docker load --input clips-doc.docker.tar

Image tag will be clips-doc or clips-doc:latest.

Usage

Assuming your working directory is $workdir.
Create a directory docs.
Copy a chosen CLIPS file ($clipsfile) to docs/ as in.clp

mkdir /docs
cp $workdir/$clipsfile $workdir/docs/in.clp
docker run -v $workdir/docs:/app/com clips-doc
# optionally
cp $workdir/docs/out.html $workdir/$clipsfile.html

a file out.html will be created in $workdir/docs/—that's the documentation of the $clipsfile

Comment

;;( Określa typ skrzyżowania do którego podjeżdżamy.
;;  @name Typ Skrzyżowania
;;  @slot kształt kształt skrzyżowania: rondo albo zwykłe skrzyżowanie
;;  @see drogaZPierwszeństwem
;;)
(deftemplate typ
  (slot kształt
    (allowed-values rondo zwykłe)
    (default ?NONE))
)

;;( Sprawdźmy, czy mamy pierwszeństwo przejazdu.
;;  @name Pierwszeństwo Przejazdu
;;  @see pierwszeństwo
;;)
(defrule drogaZPierwszeństwem
  (and
    (znaki tak)
    (typ (kształt zwykłe))
  ) =>
  (printout t "Czy droga z pierwszeństwem [tak/nie]? ")
  (assert (pierwszeństwo (read))))

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Grupprojekt för kurserna 'Javascript med Ramverk' och 'Agil Utveckling'

JavaScript-med-Ramverk-Laboration-3 Grupprojektet för kurserna Javascript med Ramverk och Agil Utveckling. Utvecklingsguide För information om hur utv

May 18, 2022

Hemsida för personer i Sverige som kan och vill erbjuda boende till människor på flykt

Getting Started with Create React App This project was bootstrapped with Create React App. Available Scripts In the project directory, you can run: np

May 3, 2022

Kurs-repo för kursen Webbserver och Databaser

Webbserver och databaser This repository is meant for CME students to access exercises and codealongs that happen throughout the course. I hope you wi

Jan 3, 2023

A documentation bot built using slash-create for its documentation, functionality derived from Eris Docs bot.

docs-bot A service that handles navigation of a docgen project manifest. Commands All arguments are required. $ npx slash-up list /docs - Search docu

Dec 15, 2022

🤖 GitHub Action which creates Issues from comments in your code

todo-issue[action] Disclosure Huge thanks to JasonEtco! After he decided to shut down his todo[bot] I've looked around for alternatives but decided to

Dec 11, 2022

JavaScript documentation generator for node using markdown and jsdoc

Dox Dox is a JavaScript documentation generator written with node. Dox no longer generates an opinionated structure or style for your docs, it simply

Jan 7, 2023

📝 Documentation Generator built with Deno

WORK IN PROGRESS ⚠️ Expect breaking changes ⚠️ 📝 Vale Vale is a static documentation generator, designed for speed, simplicity and readability. Built

Aug 16, 2022

A API documentation generator for Vue3 single file component.

doc-vue A API documentation generator for Vue3 single file component. Table of Contents Installation Write API Description Command Line Usage Programm

Oct 20, 2022

Automatic documentation generator for ESLint plugins and rules.

eslint-doc-generator Automatic documentation generator for ESLint plugins and rules. Generates the following documentation based on ESLint and top ESL

Dec 27, 2022

Inspired by https://github.com/woochanleee/project-tree-generator

Project tree workflow Introduction Project tree workflow is automatically changes the project directory structure in your README.md or any text file.

Jan 2, 2023

An `og:image` (social card) generator that is fast, browser-less (no Puppeteer), and capable of running on the edge. This package is designed to be used with Cloudflare Workers (but may be used elsewhere), with the simple API inspired by `@vercel/og`.

Cloudflare Workers OG Image Generator Using Vercel's Satori engine, and many credits to @vercel/og for the inspiration. An og:image (social card) gene

Jan 8, 2023

Obsidian text generator Plugin Text generator using GPT-3 (OpenAI)

is a handy plugin for Obsidian that helps you generate text content using the powerful language model GP

Dec 29, 2022

a babel plugin that can transform generator function to state machine, which is a ported version of typescript generator transform

Babel Plugin Lite Regenerator intro This babel plugin is a ported version of TypeScript generator transform. It can transform async and generator func

Jul 8, 2022

Types generator will help user to create TS types from JSON. Just paste your single object JSON the Types generator will auto-generate the interfaces for you. You can give a name for the root object

Types generator Types generator is a utility tool that will help User to create TS Interfaces from JSON. All you have to do is paste your single objec

Dec 6, 2022

A quickstart AWS Lambda function code generator. Downloads a template function code file, test harness file, sample SAM deffiniation and appropriate file structure.

Welcome to function-stencil 👋 A quickstart AWS Lambda function code generator. Downloads a template function code file, test harness file, sample SAM

Jun 20, 2022

Easily create and maintain style guides using CSS comments

mdcss lets you easily create and maintain style guides with CSS comments using Markdown. /*--- title: Buttons section: Base CSS --- Button styles c

Oct 4, 2022

Small (fragile) script for migrating comments from dev.to posts to Wordpress format (WXR/XML)

dev-to-wxr Small (fragile) script for migrating comments from dev.to posts to Wordpress format (WXR/XML). Useful for importing in tools like disqus. U

Jan 29, 2022

This GitHub action activates when a contributor raises a PR. It comments and reacts to the PR. Moreover, assigns the PR to the author.

Oct 1, 2022

Prototype of real-time comments and a proposal of how to make it "production-ready".

Real-time comments prototype Simple demonstration of real-time commenting. Installation After forking it, run npm install, then you need two environme

Jan 16, 2022