Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TelescopeJS/Telescope
🔭 The service ( from Client or Server ) works for render view ( markdown / code / image... ) from fetching URL.
https://github.com/TelescopeJS/Telescope
github-preview pdf snapshot telescope
Last synced: about 1 month ago
JSON representation
🔭 The service ( from Client or Server ) works for render view ( markdown / code / image... ) from fetching URL.
- Host: GitHub
- URL: https://github.com/TelescopeJS/Telescope
- Owner: telescopejs
- License: mit
- Created: 2018-02-09T01:49:36.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T13:25:21.000Z (about 2 years ago)
- Last Synced: 2024-05-22T19:28:14.359Z (7 months ago)
- Topics: github-preview, pdf, snapshot, telescope
- Language: JavaScript
- Homepage: http://23.106.151.229:8002/img/telescopejs/telescope
- Size: 181 KB
- Stars: 176
- Watchers: 10
- Forks: 46
- Open Issues: 15
-
Metadata Files:
- Readme: Readme.md
- License: License
Awesome Lists containing this project
- awesome-nodejs-projects - TelescopeJS - Telescope Nova is a free, open-source app platform built with React and powered by Meteor on the back-end. Nova provides simple building blocks such as posts, comments, forms, and modals, and makes it easy to quickly customize them to build modern, social web apps. (CMS)
- awesome-opensource-apps - Telescope
- -awesome-nodejs-projects - TelescopeJS - Telescope Nova is a free, open-source app platform built with React and powered by Meteor on the back-end. Nova provides simple building blocks such as posts, comments, forms, and modals, and makes it easy to quickly customize them to build modern, social web apps. (CMS)
- awesome-nodejs-projects - TelescopeJS - Telescope Nova is a free, open-source app platform built with React and powered by Meteor on the back-end. Nova provides simple building blocks such as posts, comments, forms, and modals, and makes it easy to quickly customize them to build modern, social web apps. (CMS)
- awesome-nodejs-projects - TelescopeJS - Telescope Nova is a free, open-source app platform built with React and powered by Meteor on the back-end. Nova provides simple building blocks such as posts, comments, forms, and modals, and makes it easy to quickly customize them to build modern, social web apps. (CMS)
README
# Telescope 🔭
[](https://travis-ci.org/telescopejs/telescope)
[](https://codecov.io/github/telescopejs/telescope?branch=master)
## What is telescope
Telescope is the service ( from client or server ) works for render view ( md / code / image... ) via fetching URL.
It's awesome that we can see any file on the internet. And telescope provides three ways (html/image/pdf) to display the view.
So you can write the markup as follows.
```html
```
## Features
- ✈ Supports client and server side.
- 🍻 Multiply [styles](https://telescopejs.github.io/?debug=true).
- 😊 The service server side supports output the view via image or pdf.
- 🍫 The code supports specified line range.
- 👍 More features is waiting for you to discover...
## Why needs telescope
[Hackernoon](https://hackernoon.com) and [Medium](https://medium.com/) has the similar [view](https://hackernoon.com/media/e406a21255c325600273fa5c8c805a89?postId=55995262a254)
via rendering gist snippet.
We can use telescope service to preview or generate the image / pdf easily!
## Installation
```bash
git clone https://github.com/telescopejs/telescope.git
cd telescope
# If you are in china, should set PUPPETEER_DOWNLOAD_HOST to speed the installation of puppeteer.
PUPPETEER_DOWNLOAD_HOST=https://npm.taobao.org/mirrors npm install
# server side, default port 8002
npm start
# or client side, default port 9999
npm run client
# build the assert of client side on `public/`
npm run client:build
```
**Meanwhile, telescope requires chrome libraries.**
You should ensure the dependencies of chrome that you had installed,
because I use the headless Chrome browser [puppeteer](https://github.com/GoogleChrome/puppeteer) to generate snapshot and pdf.
- [More information Here](https://askubuntu.com/questions/510056/how-to-install-google-chrome)
### Client Side
Open `http://localhost:9999` after setup the service on port 9999.
- The accepted query string table (server side accepted too)
| name | type | description |
| ---- | ---- | --------- |
| `q` | string | the fetching url, e.g. `picidaejs/picidaejs/master/src/index.js` `picidaejs/picidaejs` |
| `style` | string | the view style, please see `https://telescopejs.github.io/?debug=true` |
| `hlStyle` | string | the code's highlight style, please see `https://telescopejs.github.io/?debug=true` |
| `range` | number\|\[start, end\] | the code's range, e.g. `?range=10` `?range=[10]` `?range=[10, 20]` `?range=[-20, -15]` |
And specially, `debug=true` is accepted on client side for debug.
### Server Side
Temporary outside service [`http://23.106.151.229:8002/`](http://23.106.151.229:8002)
- Please try the path name below
```text
/telescopejs/telescope
/img/telescopejs/telescope
/img/telescopejs/telescope/master/package.json?hlStyle=school-book
/pdf/telescopejs/telescope
/pdf/telescopejs/telescope/master/package.json
```
## Customized
If you want to customize yourself own telescope, Please write your [plugin](src/core/plugins) or [style](src/core/styles).
## License
MIT [imcuttle](https://github.com/imcuttle)