Giter Club home page Giter Club logo

lfe-reference-guide's Introduction

{% raw %}

LFE Reference Guide

Introduction

This Gitbook (available here) is a conversion of Robert Virding's LFE User Guide.

Formatting Note

You will see code blocks in this book surrounded by double curly braces, {{ ... }}. This typographic convention is used to denote optional syntax.

Building it yourself

The conversion from Markdown into HTML pages etc. is done via the gitbook-cli npm package.

Requirements

The Makefile has a setup target that tries to install the two needed node.js packages. This works on Unbuntu and hopefully on other Unix-like systems.

You will also need Node.js installed.

Viewing the book

Once that is all set up, run make build to convert the book into HTML pages (they will be output in the _book subdirectory) or make run to start a server showing the converted pages (this will automatically update as you edit the files).

{% endraw %}

lfe-reference-guide's People

Contributors

rvirding avatar oubiwann avatar hdurer avatar zkessin avatar

Stargazers

STYLIANOS IORDANIS avatar  avatar

Watchers

 avatar James Cloos avatar  avatar

Forkers

stjordanis

lfe-reference-guide's Issues

Books without Gitbook

Gitbook has changed its services and some of our stuff no longer builds. It would be nice to use some tooling that doesn't depend upon a service going away ... and I'd love to not have to use Ruby.

Ideally, whatever solution we use going forward should satisfy these conditions:

  • allow us to continue using the content we've created in markdown with no (or very few changes)
  • be usable without having to install tons of dependencies on our systems (e.g., support docker usage)
  • not be part of some pay-for-service that could be taken away at any point in time
  • support generating and viewing books locally
    a
    One option that is used to generate the copious markdown-based books in the Rust programming language community is this one:
  • https://github.com/rust-lang/mdBook

I'll see if it meets our other criteria ...a

Check changes to setup make target

@hdurer I've just finished pushing up some changes:

  • there's a target for installing npm
  • a system-specific NPM_CMD is generated
  • gitbook install has been added to the setup target

Let me know if this breaks anything on your system/Linux ...

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.