Code Monkey home page Code Monkey logo

website's Introduction

dotnetfoundation-website

This repository contains the solution that is used to build and deploy the dotnetfoundation website.

Pull requests and issues are welcome!

Prerequisites

Build and test

The basic steps to run or build the project:

  1. Use dotnet run from the root of the repository to generate the static site.
  2. After the build, check the output folder to review the generated HTML files.

To build and preview the site, run:

dotnet run -- preview

The preceding command launches a preview web server that can be viewed from http://localhost:5080. The site automatically rebuilds and refreshes when content changes are made.

Project Structure

This website uses Statiq Web, a flexible and extensible static site generator for .NET.

  • App.Config : The configuration file for the project. Review the appSettings section of App.Config.

  • Program.cs:

    • Handles the generation of the site.
    • Starts the web server when running from Visual Studio.
    • Defines the input folder and the output of static files.
  • input : The input folder contains source files that are rendered as HTML files.

    • _partials folder contains small sections of code that are required in ther views, includes:
      • _head.cshtml: Contains the head section of the view and includes the initial stylesheet and JavaScript imports.
      • _header.cshtml: Common header used for views. Includes the main navigation.
      • _footer.cshtml: Common footer for views.
    • _layout.cshtml: Location where the page structure, include partials, nalytics code, and other imports are built.
    • index.cshtml: Main page for the site. Properties for the page can be efined at the top of the file. For example, a specific title for the page.
    • css folder contains all the stylesheet files required.
    • js folder contains the JavaScript libraries and other custom scripts.

Each file inside the input folder is processed by Statiq and will generate static output files.

website's People

Contributors

clairernovotny avatar shawnwildermuth avatar isaacrlevin avatar daveaglick avatar chrissfanos avatar arhell avatar seankilleen avatar bethmassi avatar jongalloway avatar nxtn avatar christophepichaud avatar jamiewilbraham avatar jamesmontemagno avatar maurobytes avatar sawravchy avatar simoncropp avatar selimcr avatar jstrauss avatar mairaw avatar vriesmarcel avatar tom-englert avatar youssef1313 avatar jnm2 avatar manuss20 avatar debugmodedotnet avatar v-mepa avatar cradle77 avatar ronaldmariah avatar rick-anderson avatar thebeebs avatar

Watchers

James Cloos avatar  avatar

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.