Skip to content

collection of example documents for use within cocalc's library

Notifications You must be signed in to change notification settings

sagemathinc/cocalc-examples

Folders and files

NameName
Last commit message
Last commit date

Latest commit

9b04e41 · May 2, 2023
Nov 16, 2017
Dec 15, 2022
Dec 7, 2018
Nov 16, 2017
Jun 25, 2020
Apr 2, 2018
May 2, 2023
Apr 8, 2021
Nov 16, 2017
Jun 6, 2018
Dec 15, 2022
Jan 4, 2021
Apr 12, 2019
Sep 28, 2016
May 2, 2023
Dec 15, 2022
May 24, 2018
Jun 27, 2021
Jul 11, 2019
Oct 25, 2021
May 2, 2023
Oct 25, 2021
Jan 4, 2021
May 24, 2018
Sep 15, 2018
Jun 25, 2020
Jun 25, 2020
Dec 15, 2022
May 2, 2023
Dec 15, 2022
May 2, 2023
Apr 8, 2021
Feb 28, 2018
Aug 3, 2016
Apr 30, 2023
Dec 22, 2019
Apr 12, 2019
Jul 14, 2021
Apr 30, 2023
Nov 2, 2019
Dec 16, 2017

Repository files navigation

Examples for CoCalc

This mainly adds a categorization and meta-description layer on top of this and other example collections.

Development & Indexing

  • edit index.yaml
  • call ./index.py or just do a simple make to call that script.

Datamodel

  • Goal: autogenerated JSON for the CoCalc UI, such that user can select examples from a library -- no need to think about the specific representation, only the elements that are the actually moving parts for such a selector.

  • YAML Document Types

    • first document: metadata
      • description of tags
      • description of license
      • references: point to another index description file
    • remaining documents are for each indexed entry:
      • src: Filename/Directory
      • title
      • description
      • tags: for categorization
      • license
      • start: entry point file

note: The index.py file contains additional verification of the data for validity and consistency. Just follow what the assert-exceptions complain about ...

Devnotes

If you forgot to git clone --recursive:

git submodule update --init --recursive

If you want to update all submodules in one go, do something like

git submodule foreach "git checkout master; git pull origin master"

or with resets

git submodule foreach "git fetch origin; git checkout master; git reset --hard origin/master"

You can also do make update or something like that (see makefile)

To add a new submodule, just do what the git doc says

License

Unless otherwise noted, Apache 2.0 for code and CC BY 4.0 for content.

About

collection of example documents for use within cocalc's library

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published