MaedahBatool

MkDocs Workflow! 🍒

1. Run mkdocs new project_name.
2. Open that folder by cd project_name.
3. Make a new GitHub repo.
4. Copy new Git repo instructions (the first one).
5. Run it in the project root folder.
6. Run echo "site/" >> .gitignore.
7. Run gcap 'NEW Project' (gcap` = Git Commit All Push — My personal workflow alias).
8. Run mkdocs serve

MaedahBatool

node -v
# Make sure you have Node >= 8 installed.
npm -v
# Make sure you have npm >= 5.3 installed.

MaedahBatool

curl -L https://git.io/pudlgfl -o "gulpfile.js" && curl -L https://git.io/pudlpkjs -o "package.json" && curl -L https://git.io/pudlgig -o ".gitignore" && curl -L https://git.io/pudlcg -o "config.js"

MaedahBatool

// Project Variables.
module.exports = {
	viewSrc: './views/**/*.pug',
	viewDst: './',
	styleSrc: './css/style.scss',
	styleDst: './',
	outputStyle: 'compressed',
	viewWatchFiles: './views/**/*.pug',
	styleWatchFiles: './css/**/*.scss',
	browserAutoOpen: false,

MaedahBatool

# For MAC OS X run the following command with super user.
npm install

# For Linux run the following command.
npm install

MaedahBatool

# To start pudl
npm start

# To stop pudl press CTRL (⌃) + C

MaedahBatool

/**
 * Gulpfile.
 *
 * @author Maedah Batool (https://github.com/maedahbatool)
 */

/**
 * Load Config.
 *
 * Customize your project in the config.js file

MaedahBatool

/**
 * Configuration.
 *
 * Project Configuration for gulp tasks.
 *
 * In paths you can add <<glob or array of globs>>. Edit the variables as per your project requirements.
 */

// Project options.
module.exports = {

MaedahBatool

module.exports = {
  siteMetadata: {
    title: 'Your Site Title',
    siteUrl: 'https://yoursite.com',
  },
    plugins: [      
    {
        resolve: "gatsby-remark-embed-video",
        options: {
            width: 800,

MaedahBatool

gatsby-remark-embed-video Plugin Usage

video: https://www.youtube.com/embed/2Xc9gXyf2G4 youtube: https://www.youtube.com/watch?v=2Xc9gXyf2G4 youtube: 2Xc9gXyf2G4

vimeo: https://vimeo.com/5299404 vimeo: 5299404

videoPress: https://videopress.com/v/kUJmAcSf