https://github.com/code-and-comment/code-and-comment

PWA to add comment to Github file.
https://github.com/code-and-comment/code-and-comment

preact preact-router pwa reading-code unistore

Last synced: about 2 months ago
JSON representation

PWA to add comment to Github file.

• Host: GitHub
• URL: https://github.com/code-and-comment/code-and-comment
• Owner: code-and-comment
• License: mit
• Created: 2018-11-06T14:27:07.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-14T09:06:18.000Z (3 months ago)
• Last Synced: 2024-09-14T19:56:41.869Z (3 months ago)
• Topics: preact, preact-router, pwa, reading-code, unistore
• Language: TypeScript
• Homepage: https://code-and-comment.github.io/code-and-comment/
• Size: 1.24 MB
• Stars: 17
• Watchers: 2
• Forks: 1
• Open Issues: 55
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-preact - Code and Comment - The application to add the comments to a file in Github ([demo](https://code-and-comment.github.io/code-and-comment/)). (Uncategorized / Uncategorized)

README

        
# Code and Comment

`Code and Comment` is PWA to add comment to Github file.

## Demo

[https://code-and-comment.github.io/code-and-comment/](https://code-and-comment.github.io/code-and-comment/)

### Note

The status of this application is pre-alpha.  

Many breaking changes will be added to this application.  

`https://code-and-comment.github.io/code-and-comment/` is demo.  

This is at experiment stage.  

You should not use this application as product.

## Usage

* Click "New". 

* Input the file url in Github.  

Example:  

https://github.com/developit/preact/blob/10.0.0-alpha.2/src/component.js  

https://github.com/developit/preact/blob/c66ec75176ac5df60824adbe6152ed577fa7b74f/src/component.js  

https://github.com/developit/preact/blob/master/src/component.js  

* Click code. Add the comment by Markdown.  

* When a line number is clicked, the comment is hidden.

### Link for a line

`#/r/:id/:line_number`

### Keyboard shortcuts

#### On code

* m: marking to line

* g: scrolling to marked line

## Support

* Chrome@73+

## Contribution

Please see [CONTRIBUTING.md](https://github.com/code-and-comment/code-and-comment/blob/master/CONTRIBUTING.md).