Skip to content

Commit

Permalink
README updatess and fix broken links in contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
saurabhdaware committed Aug 18, 2020
1 parent cafc52c commit b3884ff
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 16 deletions.
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,16 @@ Full documentation at: [https://github.com/abelljs/abell-renderer#-javascript-ap

This repository contains the code for static-site-generation. As you can see above that abell-renderer allows us to pass sandbox (an environment/variables, functions, etc.).

In static-site-generation, we need some variables like a variable that gives us the list and details of blogs, a function that lets us import markdown content, a variable to give a path to current blog. Abell provides all these variables and loops over a layout (`[$path]/index.abell` file) to dynamically generate blogs from a single layout. (See [src/utils/build-utils.js](https://github.com/abelljs/abell/blob/main/src/utils/build-utils.js))
In static-site-generation, we need some variables like a variable that gives us the list and details of blogs, a function that lets us import markdown content, a variable to give a path to current blog. Abell provides all these variables and loops over a layout (`[path]/index.abell` file) to dynamically generate blogs from a single layout. (See [src/utils/generate-site.js](https://github.com/abelljs/abell/blob/main/src/utils/generate-site.js))

The entry point of the code is [src/cli.js](https://github.com/abelljs/abell/blob/main/src/cli.js) which on `abell build` calls [src/commands/build.js](https://github.com/abelljs/abell/blob/main/src/commands/build.js) and on `abell serve` calls [src/commands/serve.js](https://github.com/abelljs/abell/blob/main/src/commands/serve.js)
The entry point of the code is [bin/abell.js](https://github.com/abelljs/abell/blob/main/bin/abell.js) which on `abell build` calls [src/commands/build.js](https://github.com/abelljs/abell/blob/main/src/commands/build.js) and on `abell serve` calls [src/commands/serve.js](https://github.com/abelljs/abell/blob/main/src/commands/serve.js)

Additionally, if you're developing a website, you need a dev-server that reloads when you change the code. Abell's dev server is written from scratch to provide quick reloads. The code related to reloading dev server is at [src/abell-dev-server/](https://github.com/abelljs/abell/blob/main/src/abell-dev-server/) and the code that decides what to reload is at [src/commands/serve.js](https://github.com/abelljs/abell/blob/main/src/commands/serve.js)

Throughout the code you will see a variable called `programInfo` being passed to all the functions. programInfo has all the information related to building a site (directories in the `content`, meta informations of all blogs, etc)

_Note: In most cases, you will not have to understand the whole code and you will mostly need to care about the file related to changes you're making, so even if you don't understand the whole code, that's completely normal and ok_

Thank you and if you need any additional help, you can ask in our [Slack Channel](https://join.slack.com/t/abellland/shared_invite/zt-ebklbe8h-FhRgHxNbuO_hvFDf~nZtGQ) or reach out to me on [Twitter @saurabhcodes](https://twitter.com/saurabhcodes)
Thank you and if you need any additional help, you can reach out to me on [Twitter @saurabhcodes](https://twitter.com/saurabhcodes) or ask in our Discord Channel.

<a href="https://discord.gg/ndsVpRG"><img src="https://img.shields.io/badge/discord-join%20chat-738ADB?style=for-the-badge&logo=discord&logoColor=738ADB&labelColor=black"/></a>&nbsp;
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
<p align="center"> <img width="600" alt="Cover of Abell" src="https://res.cloudinary.com/saurabhdaware/image/upload/v1588851941/abell/githubhead.png" /> </p>

<p align="center"><a href="https://npmjs.org/package/abell"><img alt="GitHub package.json version" src="https://img.shields.io/github/package-json/v/abelljs/abell/main?style=for-the-badge&labelColor=black&logo=npm&label=abell&color=darkred"></a> &nbsp;<a href="https://npmjs.org/package/abell-renderer"><img alt="GitHub package.json version" src="https://img.shields.io/github/package-json/v/abelljs/abell-renderer/main?style=for-the-badge&labelColor=black&logo=npm&label=abell%20renderer&color=darkred"></a> &nbsp;<a href="https://github.com/abelljs/abell/graphs/contributors"><img src="https://img.shields.io/github/contributors/abelljs/abell?style=for-the-badge&labelColor=black&logo=github&color=222222"></a> <br/><a href="https://join.slack.com/t/abellland/shared_invite/zt-ebklbe8h-FhRgHxNbuO_hvFDf~nZtGQ"><img src="https://img.shields.io/badge/slack-join%20channel-4A154B?style=for-the-badge&logo=slack&logoColor=pink&labelColor=black"/></a> &nbsp; <a href="https://twitter.com/abellland"><img alt="Twitter profile badge of @abellland" src="https://img.shields.io/badge/follow-@AbellLand-1DA1F2?style=for-the-badge&logo=twitter&logoColor=1DA1F2&labelColor=black"/></a> </p>
<p align="center"><a href="https://npmjs.org/package/abell"><img alt="GitHub package.json version" src="https://img.shields.io/github/package-json/v/abelljs/abell/main?style=for-the-badge&labelColor=black&logo=npm&label=abell&color=darkred"></a> &nbsp;<a href="https://npmjs.org/package/abell-renderer"><img alt="GitHub package.json version" src="https://img.shields.io/github/package-json/v/abelljs/abell-renderer/main?style=for-the-badge&labelColor=black&logo=npm&label=abell%20renderer&color=darkred"></a> &nbsp;<a href="https://github.com/abelljs/abell/graphs/contributors"><img src="https://img.shields.io/github/contributors/abelljs/abell?style=for-the-badge&labelColor=black&logo=github&color=222222"></a> <br/><a href="https://discord.gg/ndsVpRG"><img src="https://img.shields.io/badge/discord-join%20chat-738ADB?style=for-the-badge&logo=discord&logoColor=738ADB&labelColor=black"/></a>&nbsp; <a href="https://twitter.com/abellland"><img alt="Twitter profile badge of @abellland" src="https://img.shields.io/badge/follow-@AbellLand-1DA1F2?style=for-the-badge&logo=twitter&logoColor=1DA1F2&labelColor=black"/></a> </p>

<p align="center">
<b><a href="https://abelljs.org">https://abelljs.org</a></b><br/>
<b>NOT READY ENOUGH TO USE IN PRODUCTION. ☠️</b>
<b>Not ready enough for serious projects. ☠️</b>
</p>
<br/>
<p align="left">
a JavaScript based static-site-generator to help you create JSON, Markdown, or static-data based websites with minimal setup. Built on top of <a href="https://github.com/abelljs/abell-renderer">abelljs/abell-renderer</a>.
a JavaScript based static-site-generator to help you create JSON, Markdown, or static-data based websites with minimal setup in a syntax you almost already know. Built on top of <a href="https://github.com/abelljs/abell-renderer">abelljs/abell-renderer</a>.
</p>

## 📖 &nbsp; Installation

_This documentation is only for the people who want to contribute or just want to try it out for fun. Abell should not be used for production applications yet._

```sh
npx create-abell-app my-blog
cd my-blog
Expand All @@ -29,14 +27,17 @@ Changelogs are maintained in [CHANGELOG.md](CHANGELOG.md)

### 🤗 Local Installation & Contributing

- Fork [abelljs/abell](https://github.com/abelljs/abell)
- `git clone https://github.com/:github-username/abell` # Get a copy of the codebase in your codebase
- `cd abell` # Change to the folder
- `npm install` # This command installs all the dependencies
- `npm link` # This command will add the current directory to global packages.
- `cd examples/main` - Directory `examples` has sample abell projects.
- `abell build` # command to build project or
- `abell serve` # command to start dev server.
Fork [abelljs/abell](https://github.com/abelljs/abell), Then follow these commands

```sh
git clone https://github.com/:github-username/abell # Get a copy of the codebase in your codebase
cd abell # Change to the folder
npm install # This command installs all the dependencies
npm link # This command will add the current directory to global packages.
cd examples/main - Directory `examples` has sample abell projects.
abell build # command to build project or
abell serve # command to start dev server.
```

We would love to have contributions! The contributing guidelines along with local setup guide is mentioned in [CONTRIBUTING.md](CONTRIBUTING.md)

Expand Down

0 comments on commit b3884ff

Please sign in to comment.