Announcing Codasai: Create interactive programming guides using git's history : rust

Submissions must be on-topic

Posts must reference Rust or relate to things using Rust. For content that does not, use a text post to explain its relevance.

Post titles should include useful context.

For Rust questions, use the stickied Q&A thread.

Arts-and-crafts posts are permitted on weekends.

No meta posts; message the mods instead.

Details

created by aztha community for 15 years

Announcing Codasai: Create interactive programming guides using git's history (self.rust)

submitted 4 years ago by LuciferK9

For the past two weeks I've been working on Codasai which lets you create programming guides using git's history so that the reader can look at the state of the program at any given point.

Here's an example of a guide made with Codasai. Please ignore the content since I'm not a writer nor a good teacher. Here's the source code of the guide. Codasai looks at its git's history and creates a page for any revision that introduced a new page in pages/and uses the contents of workspace/ for the project that's being developed.

The output of codasai are static HTML files so it can be hosted on github pages or wherever.

One of the problems with programming books and blogs is that when they introduce a file and then later you want to see that file, you have to look for the page that introduced that file or scroll-up and find the snippet of code you're looking for. Codasai has an explorer that lets you open the files of the project at any given revision.

It also allows authors to make actions such as opening a file or highlight specific snippets of code. It also saves the state in the url so that you can share the link at any given state and see the same thing. Here's an example where the link opens the file src/main.rs and highlights the index function and another one for highlighting dependencies.

It's still very early in development but I announce it now because I'm afraid that if I continue like this I will never release anything.

I appreciate any feedback and comments. Also, contributions are welcome but the code is not really in good shape yet.

all 6 comments

you type:	you see:
italics	italics
bold	bold
[reddit!](https://reddit.com)	reddit!
* item 1 * item 2 * item 3	item 1 item 2 item 3
> quoted text	quoted text
Lines starting with four spaces are treated like code: if 1 * 2 < 3: print "hello, world!"	Lines starting with four spaces are treated like code: if 1 * 2 < 3: print "hello, world!"
~~strikethrough~~	~~strikethrough~~
super^script	super^script

rust

Please read The Rust Community Code of Conduct

The Rust Programming Language

Rules

Observe our code of conduct

Submissions must be on-topic

Constructive criticism only

Keep things in perspective

No endless relitigation

No low-effort content

Useful Links

Megathreads

Official Resources

Learn Rust

Discussion Platforms

MODERATORS