Code Monkey home page Code Monkey logo

fractal.build's Introduction

Fractal website

Site and docs for Fractal, a tool for building website component libraries: http://fractal.build

Built using Fractal's own documentation engine with a custom theme, exported to a static HTML build for deployment.

Running locally

  1. Download or clone this repo
  2. Install dependencies: npm install
  3. Start the development server: npm run dev

fractal.build deployment and hosting

http://fractal.build is hosted using Zeit Now. In order to deploy updates to the live site you need to be a member of the frctl team on Zeit.

You can generate a new Now-compatible export and automatically deploy a new instance using the npm run deploy command.

Note that this will deploy a new instance at a temporary URL - if you are happy with the changes you must then alias the fractal.build domain to the latest deployment - i.e. now alias temporary-domain-name.now.sh fractal.build

fractal.build's People

Contributors

adactio avatar allmarkedup avatar anglepoised avatar arnoud-dv avatar corygibbons avatar danfair avatar dkhuntrods avatar electerious avatar emilbjorklund avatar jeaster12 avatar matijs avatar nategreen avatar querkmachine avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

fractal.build's Issues

Error: Cannot find module './cachebust.json'

Hi,

I've ran gulp fractal:start and gulp fractal:build and both times I am getting an error with this cachebust.json.

I've looked in your repo and can't find this file, is this something that needs to be installed independently?

Compiled JS throwing error "unexpected token import"

Hi All I have a js file that is getting all of its content through the import function via modules.

It looks something like this

/**

  • App Entry Point
    */

/* global $ */

// Load site fonts
import './libs/fonts';

// import js libaries that require global scope such as jQuery, jQuery-Migrate, Foundation, etc
import './libs/global-includes';

// import the Module Controller and instantiate it
import ModuleController from './modules/module-controller';
const MC = new ModuleController();

$(document).ready(() => {
MC.loadModules($('html'));
});

However when I try and load this file into the fractal preview I get the unexpected token error import error. Is this a known issue? Is there a work around for people who have set up their projects this way ?

A good deal of the component functionality relies on JS

Confusing typo in the docs

Hi @allmarkedup

I'm just getting started with my first opportunity to use Fractal on a real project. Noticed a slight typo/issue in these docs.

Line 128 or 132 must be incorrect of this file: 08-docs/01-index.md. Is it a 'slash' or an 'underscore' that will escape expressions?

My second question, is that true for Nunjucks expressions as well? (assuming so). Not had chance to test yet.

bug: componentList filter

In your using the api example, the result of this line:

const options = Array.from(arguments).pop();

Is a string which is the full path to my fractal instance. So, when it tries to use options.fn() in this line:
ret = ret + "<li>" + options.fn(component.toJSON()) + "</li>";
options.fn is undefined

is the example code still valid?

Config data stopped working.

Hi, I blew away my project and recloned it. When running gulp fractal:build I get the same error for all components

"โœ˜ Error loading data file C:\xampp\htdocs\stsci-frontend\build\src\panini\partials\components\side-nav.config.yml: Cannot read property 'toLowerCase' of undefined"

The configs are on the same level as their html counterparts and they look like:
accordion.config.yml

context:
accordion:
-
accordion-title: "Collapsed Drawer Tab"
id: "Test"
sections:
-
section:
content: "Some Stuff"
etc.

The build finished and has all the components in the web ui but there is no context data, rendered html, notes

How can I resolve this error this was working before.

Missing documentation

Currently documentation for the following is still required:

  • Living documentation
  • Production integration
  • Test tool integrations?
  • Using a file other than fractal.js
  • Assets....
  • All API docs!!

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.