Create a static documentation website from a hosted README with Sapper

• restapify

  4 96 0.0 JavaScript

  Quickly and easily deploy a mocked REST API by using an intuitive and developer friendly JSON file structure

A few weeks earlier, I was ready to share my OS project Restapify with the world (read more about it in this post). The coverage was good, the package published and the GitHub repo had a good and welcoming README. So it was time to create the website to present the features and the documentation of it in a fancy way.

• sapper-template

  4 712 0.5 JavaScript

  Discontinued Starter template for Sapper apps

  

First part was to create the sapper project from his template:

• SurveyJS

  surveyjs.io featured

  Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App. With SurveyJS form UI libraries, you can build and style forms in a fully-integrated drag & drop form builder, render them in your JS app, and store form submission data in any backend, inc. PHP, ASP.NET Core, and Node.js.

  

• restapify-website

  1 0 0.0 Svelte

  Restapify website 🌍

You can see a full example of such website source code at https://github.com/johannchopin/restapify-website.

• semver

  724 7,026 0.6

  Semantic Versioning Specification

  

Restapify Restapify is a tool that allows you to quickly and easily deploy a local REST API by using an intuitive and developer friendly JSON file structure. Summary Why Restapify Getting Started Features Contributing Documentation Why Restapify When you start a new frontend project when the backend is not yet ready, you quickly come to the question of how to retrieve the data to be displayed. There are then many solutions that come with advantages but also some inconveniences. It's possible to use a tool like postman but it's not 100% free and require an account, to simply fetch local JSON data but it only supports a GET request or use a mocker library like json-server, mocker-api or http-fake-backend. The problem of most of this libraries is the way you have to define your API endpoints (a single file for all the routes, javascript files that took almost…

• Sapper

  33 7,187 5.3 TypeScript

  Discontinued The next small thing in web development, powered by Svelte

  

The documentation websites should be a static website (since it's tiny, doesn't change a lot over time and the SEO is better) and the documentation should be generated from a README hosted on GitHub. With this in mind, sapper was the perfect candidate to build this website.

• InfluxDB

  www.influxdata.com featured

  Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  

Suggest a related project