search

dotnet / docs

This repository contains .NET Documentation.
https://learn.microsoft.com/dotnet
Creative Commons Attribution 4.0 International
4.23k stars 5.87k forks source link

Can the repository be built locally? #23067

Open Youssef1313 opened 3 years ago

Youssef1313 commented 3 years ago

The internal review site isn't available to external contributors.

Is there a way to build the repository locally to view an article I'm editing?

It's a bit distracting to keep switching between markdown and code files.

It would be great if this is possible, and should also be documented here.

pkulikov commented 3 years ago

@Youssef1313 do you use Visual Studio Code? Do you have Docs Authoring pack installed? The doc preview feature works well sometimes in it. That is, it renders the page with the code included. However, sometimes it goes crazy and stumbles on snippets.

Youssef1313 commented 3 years ago

@pkulikov Thanks! I had the extension but wasn't aware of the feature, and snippets appear to be working for me (using the old syntax - haven't tried the new syntax yet).

Youssef1313 commented 3 years ago

Actually it doesn't seem to be working with snippets. Neither old nor new syntax. :confused: Going to re-open in case there is a way we can run the build script and get it to work.

https://github.com/dotnet/docs/blob/master/.openpublishing.build.ps1

BillWagner commented 3 years ago

Adding @meganbradley

I think the author pack rendering relies on the build service. This might get resolved automatically when the OPS build service is restored. Megan can confirm.